UserDirectory

The UserDirectory resource.

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

Operations

Method	Path	Summary	Scopes
GET	/api/v1/directory/users	User Directory List	tenant:users.read
POST	/api/v1/directory/users	User Directory Create	tenant:users.write
GET	/api/v1/directory/users/external_id/{externalId}	User Directory Get By External Id	tenant:users.read
GET	/api/v1/directory/users/{id}	User Directory Get	tenant:users.read
PUT	/api/v1/directory/users/{id}	User Directory Put	tenant:users.write
PATCH	/api/v1/directory/users/{id}	User Directory Patch	tenant:users.write
DELETE	/api/v1/directory/users/{id}	User Directory Delete	tenant:users.write
GET	/api/v1/directory/users/{id}/organizations	User Directory List Organizations	tenant:users.read

Operation details

GET /api/v1/directory/users

User Directory List

• Operation ID: userDirectoryList
• Required scopes: tenant:users.read

Parameters:

Name	In	Required	Type	Description
email	query	no	string
organizationId	query	no	string
limit	query	no	integer
cursor	query	no	string

Responses:

Status	Description	Body
200	OK	object
401	Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.	Problem (problem+json)
403	Forbidden — 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/directory/users

User Directory Create

• Operation ID: userDirectoryCreate
• Required scopes: tenant:users.write

Request body (required): application/json → CreateUserRequest

Responses:

Status	Description	Body
200	OK	object
401	Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.	Problem (problem+json)
403	Forbidden — 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/directory/users/external_id/{externalId}

User Directory Get By External Id

• Operation ID: userDirectoryGetByExternalId
• Required scopes: tenant:users.read

Parameters:

Name	In	Required	Type	Description
externalId	path	yes	string

Responses:

Status	Description	Body
200	OK	object
401	Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.	Problem (problem+json)
403	Forbidden — 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/directory/users/{id}

User Directory Get

• Operation ID: userDirectoryGet
• Required scopes: tenant:users.read

Parameters:

Name	In	Required	Type	Description
id	path	yes	string

Responses:

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

PUT /api/v1/directory/users/{id}

User Directory Put

• Operation ID: userDirectoryPut
• Required scopes: tenant:users.write

Parameters:

Name	In	Required	Type	Description
id	path	yes	string

Request body (required): application/json → UpdateUserRequest

Responses:

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

PATCH /api/v1/directory/users/{id}

User Directory Patch

• Operation ID: userDirectoryPatch
• Required scopes: tenant:users.write

Parameters:

Name	In	Required	Type	Description
id	path	yes	string

Request body (required): application/json → UpdateUserRequest

Responses:

Status	Description	Body
200	OK	object
401	Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.	Problem (problem+json)
403	Forbidden — 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/directory/users/{id}

User Directory Delete

• Operation ID: userDirectoryDelete
• Required scopes: tenant:users.write

Parameters:

Name	In	Required	Type	Description
id	path	yes	string

Responses:

Status	Description	Body
200	OK	object
401	Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.	Problem (problem+json)
403	Forbidden — 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/directory/users/{id}/organizations

User Directory List Organizations

• Operation ID: userDirectoryListOrganizations
• Required scopes: tenant:users.read

Parameters:

Name	In	Required	Type	Description
id	path	yes	string

Responses:

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