Skip to content

Product documentation

DirectoryConnector

The DirectoryConnector resource.

DirectoryConnector

The DirectoryConnector resource.

Base URL: https://api.stg.thoryn.org

Operations

MethodPathSummaryScopes
PUT/api/v1/directories/{directoryId}/connector-credentialDirectory Connector Set Connector Credentialtenant:orgs.write
DELETE/api/v1/directories/{directoryId}/connector-credentialDirectory Connector Clear Connector Credentialtenant:orgs.write
POST/api/v1/directories/{directoryId}/probeDirectory Connector Probetenant:orgs.write
GET/api/v1/directories/{directoryId}/scim-bearersDirectory Connector List Bearerstenant:orgs.read
POST/api/v1/directories/{directoryId}/scim-bearersDirectory Connector Mint Bearertenant:orgs.write
DELETE/api/v1/directories/{directoryId}/scim-bearers/{bearerId}Directory Connector Revoke Bearertenant:orgs.write
POST/api/v1/directories/{directoryId}/scim-bearers/{bearerId}/rotateDirectory Connector Rotate Bearertenant:orgs.write

Operation details

PUT /api/v1/directories/{directoryId}/connector-credential

Directory Connector Set Connector Credential

  • Operation ID: directoryConnectorSetConnectorCredential
  • Required scopes: tenant:orgs.write

Parameters:

NameInRequiredTypeDescription
directoryIdpathyesstring

Request body (required): application/jsonSetConnectorCredentialRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)

DELETE /api/v1/directories/{directoryId}/connector-credential

Directory Connector Clear Connector Credential

  • Operation ID: directoryConnectorClearConnectorCredential
  • Required scopes: tenant:orgs.write

Parameters:

NameInRequiredTypeDescription
directoryIdpathyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)

POST /api/v1/directories/{directoryId}/probe

Directory Connector Probe

  • Operation ID: directoryConnectorProbe
  • Required scopes: tenant:orgs.write

Parameters:

NameInRequiredTypeDescription
directoryIdpathyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)

GET /api/v1/directories/{directoryId}/scim-bearers

Directory Connector List Bearers

  • Operation ID: directoryConnectorListBearers
  • Required scopes: tenant:orgs.read

Parameters:

NameInRequiredTypeDescription
directoryIdpathyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)

POST /api/v1/directories/{directoryId}/scim-bearers

Directory Connector Mint Bearer

  • Operation ID: directoryConnectorMintBearer
  • Required scopes: tenant:orgs.write

Parameters:

NameInRequiredTypeDescription
directoryIdpathyesstring

Request body: application/jsonMintScimBearerRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)

DELETE /api/v1/directories/{directoryId}/scim-bearers/{bearerId}

Directory Connector Revoke Bearer

  • Operation ID: directoryConnectorRevokeBearer
  • Required scopes: tenant:orgs.write

Parameters:

NameInRequiredTypeDescription
directoryIdpathyesstring
bearerIdpathyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)

POST /api/v1/directories/{directoryId}/scim-bearers/{bearerId}/rotate

Directory Connector Rotate Bearer

  • Operation ID: directoryConnectorRotateBearer
  • Required scopes: tenant:orgs.write

Parameters:

NameInRequiredTypeDescription
directoryIdpathyesstring
bearerIdpathyesstring

Request body: application/jsonMintScimBearerRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)