Skip to content

OrchestratorUserRole

A role assigned to an Orchestrator user. Returned on OrchestratorUserGetResponse.userRoles when expand includes userRoles.

Properties

Property Type Description
id number Id of the user-role association; 0 when the API does not materialize it on expanded roles — use userId + roleId to identify the pair.
roleId number The id of the associated role.
roleName null | string The name of the associated role, or null when the API does not populate it on expanded roles.
roleType null | OrchestratorUserRoleType Scope at which the role applies, or null when the API does not populate it on expanded roles.
userId number The id of the associated user.
userName null | string The name of the associated user, or null when the API does not populate it on expanded roles.