Endpoint Groups

Identity

Principals, groups, and API key management for authenticated access.

List API keysGET

/api-keys

Operation IDlistAPIKeys

Query Parameters

Name	Type	Required	Description
`max_results`	`integer`	`false`	-
`page_token`	`string`	`false`	-
`principal_id`	`string`	`false`	-

Responses

Code	Description
`200`	The request has succeeded.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`429`	Client error
`500`	Server error

Create API keyPOST

/api-keys

Operation IDcreateAPIKey

Request Body

Required: true
Content types: application/json

Responses

Code	Description
`201`	The request has succeeded and a new resource has been created as a result.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

Clean up expired API keysPOST

/api-keys/cleanup

Operation IDcleanupExpiredAPIKeys

Responses

Code	Description
`200`	The request has succeeded.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

Delete API keyDELETE

/api-keys/{apiKeyId}

Operation IDdeleteAPIKey

Path Parameters

Name	Type	Required	Description
`apiKeyId`	`string`	`true`	-

Responses

Code	Description
`204`	There is no content to send for this request, but the headers may be useful.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

List groupsGET

/groups

Operation IDlistGroups

Query Parameters

Name	Type	Required	Description
`max_results`	`integer`	`false`	-
`page_token`	`string`	`false`	-

Responses

Code	Description
`200`	The request has succeeded.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

Create groupPOST

/groups

Operation IDcreateGroup

Request Body

Required: true
Content types: application/json

Responses

Code	Description
`201`	The request has succeeded and a new resource has been created as a result.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

Get groupGET

/groups/{groupId}

Operation IDgetGroup

Path Parameters

Name	Type	Required	Description
`groupId`	`string`	`true`	-

Responses

Code	Description
`200`	The request has succeeded.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`404`	The server cannot find the requested resource.
`429`	Client error
`500`	Server error

Update groupPATCH

/groups/{groupId}

Operation IDupdateGroup

Path Parameters

Name	Type	Required	Description
`groupId`	`string`	`true`	-

Request Body

Required: true
Content types: application/json

Responses

Code	Description
`200`	The request has succeeded.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`404`	The server cannot find the requested resource.
`429`	Client error
`500`	Server error

Delete groupDELETE

/groups/{groupId}

Operation IDdeleteGroup

Path Parameters

Name	Type	Required	Description
`groupId`	`string`	`true`	-

Responses

Code	Description
`204`	There is no content to send for this request, but the headers may be useful.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

List group membersGET

/groups/{groupId}/members

Operation IDlistGroupMembers

Path Parameters

Name	Type	Required	Description
`groupId`	`string`	`true`	-

Query Parameters

Name	Type	Required	Description
`max_results`	`integer`	`false`	-
`page_token`	`string`	`false`	-

Responses

Code	Description
`200`	The request has succeeded.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`404`	The server cannot find the requested resource.
`429`	Client error
`500`	Server error

Create group memberPOST

/groups/{groupId}/members

Operation IDcreateGroupMember

Path Parameters

Name	Type	Required	Description
`groupId`	`string`	`true`	-

Request Body

Required: true
Content types: application/json

Responses

Code	Description
`201`	The request has succeeded and a new resource has been created as a result.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

Delete group memberDELETE

/groups/{groupId}/members/{memberType}/{memberId}

Operation IDdeleteGroupMember

Path Parameters

Name	Type	Required	Description
`groupId`	`string`	`true`	-
`memberId`	`string`	`true`	-
`memberType`	`PrincipalType`	`true`	-

Responses

Code	Description
`204`	There is no content to send for this request, but the headers may be useful.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

List principalsGET

/principals

Operation IDlistPrincipals

Query Parameters

Name	Type	Required	Description
`max_results`	`integer`	`false`	-
`page_token`	`string`	`false`	-

Responses

Code	Description
`200`	The request has succeeded.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

Create principalPOST

/principals

Operation IDcreatePrincipal

Request Body

Required: true
Content types: application/json

Responses

Code	Description
`201`	The request has succeeded and a new resource has been created as a result.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

Get principalGET

/principals/{principalId}

Operation IDgetPrincipal

Path Parameters

Name	Type	Required	Description
`principalId`	`string`	`true`	-

Responses

Code	Description
`200`	The request has succeeded.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`404`	The server cannot find the requested resource.
`429`	Client error
`500`	Server error

Delete principalDELETE

/principals/{principalId}

Operation IDdeletePrincipal

Path Parameters

Name	Type	Required	Description
`principalId`	`string`	`true`	-

Responses

Code	Description
`204`	There is no content to send for this request, but the headers may be useful.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

Update principal adminPUT

/principals/{principalId}/admin

Operation IDupdatePrincipalAdmin

Path Parameters

Name	Type	Required	Description
`principalId`	`string`	`true`	-

Request Body

Required: true
Content types: application/json

Responses

Code	Description
`204`	There is no content to send for this request, but the headers may be useful.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

← Health Integrations →