CLclerk
Directories

Retrieve a directory group

Changed on

Returns one group of the directory, as reported by the identity provider. Responds with 404 once the identity provider has deleted the group.

get/directories/{directory_id}/groups/{group_id}

Request

  • Base URL
    https://api.clerk.com/v1
  • URL
    https://api.clerk.com/v1/directories/{directory_id}/groups/{group_id}
  • Auth
    HTTP bearer

Path parameters

directory_idstring required

The ID of the directory.

group_idstring required

The ID of the group, as assigned by the directory.

Response

A group reported by the identity provider for a directory.

object'directory_group' required

String representing the object's type. Always "directory_group".

idstring required

The group ID from the identity provider.

display_namestring required

The display name of the group.

updated_atinteger required

Unix timestamp (milliseconds) of when the group was last updated on the identity provider.

Changes