POST/groups/external-keys

Updates a list of group external keys.

Authorization

oauth2

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

Scope

directory

HTTP Request

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

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
groups array (TenantUniqueExternalKeyRequest) 

List of external keys


required
minItems : 1
maxItems : 50 

TenantUniqueExternalKeyRequest

PropertyTypeDescription
id string 

ID.

It is the ID automatically assigned to a resource.
To add, update or delete external keys, the following types are available:

  • Mail
  • Resource ID
  • External key in "externalKey:{externalKey}" format

required 
externalKey string 

Customer's external key.

Updating external keys works as follows:

  • If no existing external key is found, a new one is added.
  • If an existing external key is found, a new one replaces it.
  • An external key whose value is NULL is deleted.
  • An external key can be up to 100 characters in length and cannot contain some special characters, %, #, /, and ?.

maxLength : 100 

Request Example

example

1{2  "groups": [3    {4      "id": "group127-8545-4463-603b-04d550d23bf",5      "externalKey": "GROUP_EXT_01"6    },7    {8      "id": "groupa36-79c8-4858-6c23-041098774484",9      "externalKey": "GROUP_EXT_02"10    }11  ]12}

Response

HTTP 204

No Content

HTTP 400

Bad Request

HTTP 404

Not Found

HTTP 409

Conflict