Get all users in a Group

1min

GET
https://{tenantSubdomain}.getos1.com/core/api/v1/aaa/groups/{groupId}/users
This endpoint retrieves details of Users in a Group of a Tenant by groupId.
Path Parameters
groupId
string
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-AUTH
string
X-COREOS-TID
string
*
X-COREOS-USERINFO
string
Query Parameters
limit
integer
nextPage
string
Responses
200
OK - The request succeeded.
SuccessUserGroupResponse
data
object
One Of
GroupUserResponse 
request
Request
error
Error
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
ErrorResponse
error
Error
request
Request
401
Unauthorized -  The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that Tenant.
ErrorResponse
error
Error
request
Request
403
Forbidden - The client's identity is known to the server but it does not have access rights to the requested resource. Verify that you're using the correct client ID and client secret or grant the client the necessary roles to access the resource.
ErrorResponse
error
Error
request
Request
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
request
Request
503
Server error - The server is not ready to handle the request. This could be due to maintenance downtime or system resource constraints.
ErrorResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubdomain}.getos1.com/core/api/v1/aaa/groups/{groupId}/users?limit=50' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{tenantSubdomain}.getos1.com/core/api/v1/aaa/groups/{groupId}/users?limit=50' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
403
404
503
// OK - The request succeeded. 
{
  "data": {},
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {
      "errorTrace": [
        {}
      ],
      "id": ""
    }
  }
}
// OK - The request succeeded. 
{
  "data": {},
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {
      "errorTrace": [
        {}
      ],
      "id": ""
    }
  }
}
﻿
﻿

Updated 30 Oct 2023

Did this page help you?

Update users mapping for a Group. Please note that requests that exceed the 375KB size limit will be rejected. Avoid passing large payloads to prevent exceeding this limit.

Update Roles mapping for a Group