Read the directory connections of the organization the token was issued for, along with their synced users and groups.
List the Directory Sync connections for the token’s organization.
GraphQL
| query DirectoryConnections($after: String, $before: String, $limit: Int, $order: PaginationOrder, $search: String) { | |
| directoryConnections(after: $after, before: $before, limit: $limit, order: $order, search: $search) { | |
| data { | |
| createdAt | |
| externalKey | |
| id | |
| lastSyncRunAt | |
| metadata { | |
| groups | |
| } | |
| name | |
| organizationId | |
| state | |
| type | |
| updatedAt | |
| } | |
| listMetadata { | |
| after | |
| before | |
| } | |
| } | |
| } |
| { | |
| "data": { | |
| "directoryConnections": { | |
| "data": [ | |
| { | |
| "createdAt": "2024-01-01T00:00:00.000Z", | |
| "externalKey": "externalKey_example", | |
| "id": "id_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "lastSyncRunAt": "2024-01-01T00:00:00.000Z", | |
| "metadata": { | |
| "groups": 10 | |
| }, | |
| "name": "name_example", | |
| "organizationId": "organizationId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "state": "state_example", | |
| "type": "type_example", | |
| "updatedAt": "2024-01-01T00:00:00.000Z" | |
| } | |
| ], | |
| "listMetadata": { | |
| "after": "after_example", | |
| "before": "before_example" | |
| } | |
| } | |
| } | |
| } |
directoryConnections
Parameters
after: String
before: String
limit: Int
Returns DirectoryList!
Return a Directory Sync connection by ID within the token’s organization.
GraphQL
| query DirectoryConnection($id: ID!) { | |
| directoryConnection(id: $id) { | |
| createdAt | |
| externalKey | |
| id | |
| lastSyncRunAt | |
| metadata { | |
| groups | |
| users { | |
| active | |
| inactive | |
| } | |
| } | |
| name | |
| organizationId | |
| state | |
| type | |
| updatedAt | |
| } | |
| } |
| { | |
| "data": { | |
| "directoryConnection": { | |
| "createdAt": "2024-01-01T00:00:00.000Z", | |
| "externalKey": "externalKey_example", | |
| "id": "id_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "lastSyncRunAt": "2024-01-01T00:00:00.000Z", | |
| "metadata": { | |
| "groups": 10, | |
| "users": { | |
| "active": 10, | |
| "inactive": 10 | |
| } | |
| }, | |
| "name": "name_example", | |
| "organizationId": "organizationId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "state": "state_example", | |
| "type": "type_example", | |
| "updatedAt": "2024-01-01T00:00:00.000Z" | |
| } | |
| } | |
| } |
directoryConnection
Parameters
id: ID!
Returns Directory!
createdAt: DateTime!
externalKey: String!
id: ID!
name: String!
organizationId: ID!
updatedAt: DateTime!
List the users of a Directory Sync connection.
GraphQL
| query DirectoryUsers($after: String, $before: String, $directoryId: ID!, $limit: Int, $order: PaginationOrder) { | |
| directoryUsers(after: $after, before: $before, directoryId: $directoryId, limit: $limit, order: $order) { | |
| data { | |
| createdAt | |
| directoryId | |
| firstName | |
| id | |
| idpId | |
| lastName | |
| organizationId | |
| state | |
| updatedAt | |
| username | |
| } | |
| listMetadata { | |
| after | |
| before | |
| } | |
| } | |
| } |
| { | |
| "data": { | |
| "directoryUsers": { | |
| "data": [ | |
| { | |
| "createdAt": "2024-01-01T00:00:00.000Z", | |
| "directoryId": "directoryId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "email": "email_example", | |
| "firstName": "firstName_example", | |
| "id": "id_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "idpId": "idpId_example", | |
| "lastName": "lastName_example", | |
| "organizationId": "organizationId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "state": "state_example", | |
| "updatedAt": "2024-01-01T00:00:00.000Z", | |
| "username": "username_example" | |
| } | |
| ], | |
| "listMetadata": { | |
| "after": "after_example", | |
| "before": "before_example" | |
| } | |
| } | |
| } | |
| } |
directoryUsers
Parameters
after: String
before: String
limit: Int
Returns DirectoryUserList!
List the groups of a Directory Sync connection.
GraphQL
| query DirectoryGroups($after: String, $before: String, $directoryId: ID!, $limit: Int, $order: PaginationOrder) { | |
| directoryGroups(after: $after, before: $before, directoryId: $directoryId, limit: $limit, order: $order) { | |
| data { | |
| createdAt | |
| directoryId | |
| id | |
| idpId | |
| name | |
| organizationId | |
| updatedAt | |
| } | |
| listMetadata { | |
| after | |
| before | |
| } | |
| } | |
| } |
| { | |
| "data": { | |
| "directoryGroups": { | |
| "data": [ | |
| { | |
| "createdAt": "2024-01-01T00:00:00.000Z", | |
| "directoryId": "directoryId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "id": "id_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "idpId": "idpId_example", | |
| "name": "name_example", | |
| "organizationId": "organizationId_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "updatedAt": "2024-01-01T00:00:00.000Z" | |
| } | |
| ], | |
| "listMetadata": { | |
| "after": "after_example", | |
| "before": "before_example" | |
| } | |
| } | |
| } | |
| } |