Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

General Information


ServiceAPIMethod
urac/admin/users/countGET


Data Model: Users

Workflow: Count Users Flow

Input


NameSourceMandatoryTypeSpecial FormatDescription
tIdQueryNOStringN/AIf set, the api will return the users of a specific tenant; else the api returns all the users in the database


Output


Valid Response

Valid Response Sample
{
	"result": true,
	"data": {
		"count": 12
	}
}


Invalid Response

Error Response Sample
{
    "result":false,
    "errors":{
        "codes":[600],
        "details":[
            {
                "code": 600,
                "message": "Database connection error"
            }
        ]
    }
}



Error Codes



Code
Description
400
Database connection error


Example (CURL)


Request

Calling List Users API
 > CURL -X GET http://127.0.0.1:4000/urac/admin/users/count?tId=5551aca9e179c39b760f7a1a

Response

List Users API response
{
	"result": true,
	"data": {
		"count": 12
	}
}
  • No labels