Skip to main content
Sign in
Español
Menu

List of allowed users belonging to a specific realm and user group

  • Updated

​Request Params

  • realm_id – The realm identifier

  • usergroup_id – The user group identifier

  • page: int → i.e : 0 → Current retrieved page. MANDATORY

  • size: int → i.e : 10 → Number of retrieved items. MANDATORY

  • sort: string → i.e :ASC, DESC → Sort type. OPTIONAL

  • request header

    • Authorization {jwt}

 

Request

 

GET https://afw.biocryptology.com/realm/v1/api/realms/{realm_id}/usergroup/{uuid}/allowedUsers

I.E of request:

https://afw.biocryptology.com/realm/v1/api/realms/{realm_id}/usergroup/{uuid}/allowedUsers?page=0&size=1&sort=asc

 

Response

  • OK 200 - AllowedUsers retrieved correctly.
{
"totalPages": 0,
"totalElements": 0,
"size": 0,
"content": [
{
"email": "string",
"phone": "string",
"description": "string",
"created": "2024-03-08T13:37:35.947Z",
"updated": "2024-03-08T13:37:35.947Z",
"bioappId": "string"
}
],
"number": 0,
"sort": {
"empty": true,
"unsorted": true,
"sorted": true
},
"pageable": {
"offset": 0,
"sort": {
"empty": true,
"unsorted": true,
"sorted": true
},
"paged": true,
"unpaged": true,
"pageNumber": 0,
"pageSize": 0
},
"last": true,
"first": true,
"numberOfElements": 0,
"empty": true
}
  • KO 400
    • Invalid realm id - { message: "invalid_realm_id" }
    • Invalid usergroupid - { message: “invalid_id_format” }
    • Invalid page
    • Invalid size
  • KO 401 - No message attached

    • Token or JWT are invalid

    • Realm not found

    • Not allowed sort param

  • KO 404
    • User group not found - { message: "usergroup_not_found” }

Related articles