Roles
Define and assign organization roles
Use the role client to define organization roles and list role assignments.
Create roles and permissions for authorization after you have organizations and users.
CreateRole
Section titled “CreateRole”#asyncCreateRole
CreateRole creates a new role in the environment
Request context
Role creation payload.
The created resource.
GetRole
Section titled “GetRole”#asyncGetRole
GetRole retrieves a role by name
Request context
Role name.
The response payload for this operation.
ListRoles
Section titled “ListRoles”#asyncListRoles
ListRoles lists all roles in the environment
Request context
Paginated results.
UpdateRole
Section titled “UpdateRole”#asyncUpdateRole
UpdateRole updates an existing role by name
Request context
Role name.
Role update payload.
The updated resource.
DeleteRole
Section titled “DeleteRole”#asyncDeleteRole
DeleteRole deletes a role by name
Request context
Role name.
Reassign role name.
error
GetRoleUsersCount
Section titled “GetRoleUsersCount”#asyncGetRoleUsersCount
GetRoleUsersCount gets the count of users associated with a role
Request context
Role name.
The response payload for this operation.
CreateOrganizationRole
Section titled “CreateOrganizationRole”#asyncCreateOrganizationRole
CreateOrganizationRole creates a new role in an organization
Request context
Org id.
Role creation payload.
The created resource.
GetOrganizationRole
Section titled “GetOrganizationRole”#asyncGetOrganizationRole
GetOrganizationRole retrieves an organization role by name
Request context
Role name.
The response payload for this operation.
ListOrganizationRoles
Section titled “ListOrganizationRoles”#asyncListOrganizationRoles
ListOrganizationRoles lists all roles in an organization
Request context
Org id.
Paginated results.
UpdateOrganizationRole
Section titled “UpdateOrganizationRole”#asyncUpdateOrganizationRole
UpdateOrganizationRole updates an existing organization role by name
Request context
Role name.
Role update payload.
The updated resource.
DeleteOrganizationRole
Section titled “DeleteOrganizationRole”#asyncDeleteOrganizationRole
DeleteOrganizationRole deletes an organization role by name
Request context
Role name.
Reassign role name.
error
GetOrganizationRoleUsersCount
Section titled “GetOrganizationRoleUsersCount”#asyncGetOrganizationRoleUsersCount
GetOrganizationRoleUsersCount gets the count of users associated with an organization role
Request context
Role name.
The response payload for this operation.
UpdateDefaultOrganizationRoles
Section titled “UpdateDefaultOrganizationRoles”#asyncUpdateDefaultOrganizationRoles
UpdateDefaultOrganizationRoles updates the default roles for an organization
Request context
Default member role.
The updated resource.
DeleteOrganizationRoleBase
Section titled “DeleteOrganizationRoleBase”#asyncDeleteOrganizationRoleBase
DeleteOrganizationRoleBase deletes the base relationship for an organization role
Request context
Role name.
error
DeleteRoleBase
Section titled “DeleteRoleBase”#asyncDeleteRoleBase
DeleteRoleBase deletes the base relationship for an environment-level role
Request context
Role name.
error
UpdateDefaultRoles
Section titled “UpdateDefaultRoles”#asyncUpdateDefaultRoles
UpdateDefaultRoles updates the environment-level default creator and member roles
Request context
Default member role.
The updated resource.
ListDependentRoles
Section titled “ListDependentRoles”#asyncListDependentRoles
ListDependentRoles lists all roles that depend on the specified role
Request context
Role name.
Paginated results.