Org Management
Organization management functions.
This endpoint provides the OIDC Sector Identifier used for calculating Pseudonymous Identifiers. It ensures that clients within the same sector can access the same unique identifier for users, enhancing privacy and data protection. Use this to manage user identifiers securely within your organization.
The organization ID to fetch.
OK
Unauthorized
This endpoint allows users to create a new organization. The organization will be assigned a default owner upon creation. Ensure that you provide all necessary details in the request body. This operation is essential for users managing organizational accounts.
👤 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.directory.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.
An OIDC service account that was authenticated.
OK
Unauthorized
This endpoint checks if the specified domain is claimed or available for assignment to a new organization. Ensuring unique domain names is crucial for organizational identity. Use this to prevent conflicts and maintain a clear domain structure.
👤 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.directory.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.
An OIDC service account that was authenticated.
OK
Unauthorized
This endpoint provides suggestions for organizations that a user can join. It takes into account the user's email domain and other trusted factors to enhance the relevance of the suggestions. This is particularly useful for users looking to expand their professional network within the platform.
👤 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.directory.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.
An OIDC service account that was authenticated.
OK
Unauthorized
Fetches the organization information associated with the provided organization ID. This endpoint is intended for users with access to their organizations, ensuring that only authorized users can view sensitive organization data.
👤 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.directory.get 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.
An OIDC service account that was authenticated.
The organization ID to retrieve.
OK
Unauthorized
This endpoint allows users to update an existing organization. It ensures that the organization retains its default ownership structure. This operation is crucial for maintaining accurate organizational data and is accessible to authorized users.
👤 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.directory.update 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.
An OIDC service account that was authenticated.
OK
Unauthorized
This endpoint allows for the deletion of an organization identified by its ID. It ensures that only authorized users can perform this action, maintaining the integrity of the organization management system. Use this operation to remove organizations that are no longer needed.
👤 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.directory.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.
An OIDC service account that was authenticated.
OK
No content
Unauthorized
No content
This endpoint retrieves all members associated with the given organization ID. It ensures that the current user has the necessary permissions to view this information. This is essential for understanding the organizational structure and collaboration opportunities.
👤 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.directory.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.
An OIDC service account that was authenticated.
OK
Unauthorized
This endpoint allows users to join an organization by providing a confirmed email address that matches the organization's domain. Users may also join if they have received an invitation from an existing member. Basic membership permissions will be granted upon successful verification.
👤 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.directory.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.
An OIDC service account that was authenticated.
OK
No content
Unauthorized
No content
This operation allows the authenticated user to remove their access and permissions to the specified organization. It ensures that the user's association with the organization is terminated, reflecting the change in their organizational role. This is crucial for maintaining accurate access control and organizational membership.
👤 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.directory.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.
An OIDC service account that was authenticated.
OK
No content
Unauthorized
No content
This endpoint allows the addition of a member to a specified organization. It requires the organization ID and the subject ID of the member to be added. Ensure that the authenticated 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.directory.members.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.
An OIDC service account that was authenticated.
OK
No content
Unauthorized
No content
This endpoint allows the removal of a specified member from the organization. It ensures that only authorized users can perform this action, maintaining the integrity of the organization's membership. This operation is crucial for managing organizational roles and responsibilities effectively.
👤 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.directory.members.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.
An OIDC service account that was authenticated.
OK
No content
Unauthorized
No content
This endpoint returns a comprehensive list of permissions associated with the specified organization. It aggregates permissions across all roles and groups, providing a clear overview of access rights. This information is essential for understanding the permission landscape within the organization.
👤 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.
An OIDC service account that was authenticated.
OK
Unauthorized
This endpoint returns a list of all roles currently defined within the specified organization. It is essential for understanding role assignments and permissions associated with the organization. Use this information to manage access and responsibilities effectively.
👤 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.roles.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.
An OIDC service account that was authenticated.
OK
Unauthorized
Last updated