Org Unit Management

Organization management functions.

List organization assignments for a specific user

get

Retrieve the organization assignments associated with the specified user. This endpoint provides visibility into the user's roles within the organization, helping to manage permissions effectively. Ideal for administrators and users to understand their organizational context.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Permission: org.user.assignment.list is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations
OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:
Path parameters
organizationIdstringRequired
userIdstringRequired
Responses
200

OK

*/*
get
/directory/orgs/{organizationId}/users/{userId}/ous

Assign organization units to a user.

post

This endpoint updates the organization assignment for a specified user. It allows for the management of user roles within the organization. Ensure that the user has the necessary permissions to perform this action.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Permission: org.user.assignment.create is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations
OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:
Path parameters
organizationIdstringRequired
userIdstringRequired
Body
idstringOptional
customer_idstringOptional
org_idstringOptional
org_pathstringOptional
assigned_tostringOptional
assignee_typestring · enumOptionalPossible values:
Responses
200

OK

*/*
post
/directory/orgs/{organizationId}/users/{userId}/ous

Remove organization unit from specified user

delete

This endpoint allows the removal of an organization unit assignment from a user. It is intended for use by authorized personnel to manage user roles effectively. Ensure that the user ID and organization ID are correctly specified to avoid unintended deletions.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Permission: org.user.assignment.delete is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations
OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:
Path parameters
organizationIdstringRequired
userIdstringRequired
Body
stringOptional
Responses
200

OK

No content

delete
/directory/orgs/{organizationId}/users/{userId}/ous

No content

Last updated