Get Group Users

Get all users in a specific group.

URL

https://{{HOST}}/security/group/users?groupId={groupId}&v={version}

Method

GET

Required IMS Scopes

  • securityapi_all

Versions Supported

  • 2.0 (Default)

URL Query Parameters

Name Description Example Type
v
optional		 Version of the api to use /group?v=2.0 number
groupId
required		 The ID of the group. /group?groupId=testGroup string

Request Header Parameters

Type Value Description
Authorization
required		 Bearer {access_token} IMS access token

Example

Request

curl -X GET 
  'https://{{HOST}}/security/group/users?groupId=testGroup&v=2.0' 
  -H 'Authorization: Bearer {access_token}'

Response

[{
    "username": "user@jci.com",
    "credentials": { "protectedPassword": "null", "crypto": "null" },
    "identity": {
        "address": "null",
        "email": "null",
        "extraClaims": "null",
        "familyName": "null",
        "givenName": "null",
        "name": "",
        "organization": "jci.com",
        "phone": "null",
        "website": "null"
    },
    "meta": {
        "created": "2017-02-23T19:42:04.1115633Z",
        "emailVerified": "true",
        "enabled": "true",
        "failedLoginCount": "null",
        "failedPasswordResetCount": "null",
        "lastFailedLogin": "null",
        "lastFailedPasswordReset": "null",
        "lastLogin": "null",
        "lastUpdated": "null",
        "phoneVerified": "true",
        "provider": "null",
        "providerId": "null"
    },
    "privilege": { "roles": [] },
    "id": "user@jci.com",
    "subject": "e15dd8dc-578c-46f9-adc3-fe64e3fbcde8"
}]

Errors

Error Description
Error Name Description of Error

Response Body Parameters

Name Description Schema
Object Name Description object definition
username Description object definition
credentials Description object definition
identity Description object definition
meta Description object definition
privilege Description object definition
id Description object definition
subject Description object definition