GET/groups/external-keys

Gets a list of group external keys.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

directory
directory.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/groups/external-keys

Query Parameters

ParameterTypeDescription
domainId integer 

Domain ID


example : 10000001
format : int32 
count integer 

Number of items to get


default : 100
minimum : 1
maximum : 100
example : 100
format : int32 
cursor string 

Cursor


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 
hasExternalKey boolean 

Gets resources based on whether they have external keys.

  • true: Gets the resources which have external keys.
  • false: Gets the resources which do not have external keys.
  • If not specified, it gets all resources.

example : false 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
groups array (TenantUniqueExternalKeyResponse) 

Group information

 
responseMetaData object (responseMetaData) 

Response metadata

 

TenantUniqueExternalKeyResponse

PropertyTypeDescription
domainId integer 

Domain ID


format : int32
readOnly : true 
name string 

First name


readOnly : true 
email string 

Email address


readOnly : true 
id string 

ID.

It is the ID automatically assigned to a resource.


readOnly : true 
externalKey string 

Customer's external key.


readOnly : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination

 

Response Example

example

1{2  "groups": [3    {4      "domainId": 10000001,5      "name": "name01",6      "email": "group01@example.com",7      "id": "group127-8545-4463-603b-04d550d23bf",8      "externalKey": "GROUP_EXT_01"9    },10    {11      "domainId": 10000001,12      "name": "name02",13      "email": "group02@example.com",14      "id": "groupa36-79c8-4858-6c23-041098774484",15      "externalKey": "GROUP_EXT_02"16    }17  ],18  "responseMetaData": {19    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="20  }21}