Members

List Organization Members Endpoint

get

Endpoint to list organization members.

Args: organization_id: ID of the organization for which to list the members. role_id: ID of the role to filter by. include_teams: Include teams in the result. include_users: Include users in the result. include_service_accounts: Include service accounts in the result. user: The authenticated user. rbac: RBAC component. organization_manager: Organization manager

Returns: List of organization members.

Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:

OAuth2authorizationCodeRequired
Authorization URL: Token URL: Refresh URL:
Path parameters
organization_idstring · uuidRequired
Query parameters
role_idany ofOptional
string · uuidOptional
or
nullOptional
include_usersbooleanOptionalDefault: true
include_service_accountsbooleanOptionalDefault: true
include_teamsbooleanOptionalDefault: true
Responses
chevron-right
200

Successful Response

application/json
get
/organizations/{organization_id}/members

Remove Organization Member Endpoint

delete

Endpoint to remove a member from an organization.

Args: organization_id: ID of the organization from which to remove the user. user_id: ID of the user to remove from the organization. user: The authenticated user. rbac: RBAC component. organization_manager: Organization manager. user_manager: User manager.

Raises: IllegalOperationError: If the member is a service account.

Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:

OAuth2authorizationCodeRequired
Authorization URL: Token URL: Refresh URL:
Path parameters
organization_idstring · uuidRequired
Query parameters
user_idstring · uuidRequired
Responses
chevron-right
200

Successful Response

application/json
Responseany
delete
/organizations/{organization_id}/members

No content

Last updated

Was this helpful?