JUjumpcloud
Roles

Update a role.

Updates an existing role with the specified ID.

put/api/v2/roles/{role_id}

Request

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

x-provider-idstring

Multi-tenant Provider identifier that can be obtained from console settings.

Request body

namestring

Updated name of the role

scopesstring[]

Updated list of permission scopes for this role

providerIdstring

ID of the provider to associate with this role

organizationIdsstring[]

List of organization IDs to associate with this role

descriptionstring

Description of the role and its purpose

Response

Successfully retrieved the role.

idstring

ID of the role

namestring required

Name of the role

scopesstring[] required

List of permission scopes associated with this role.

providerIdstring

ID of the provider associated with this role.

organizationIdsstring[]

List of organization IDs this role is associated with.

descriptionstring

Description of the role and its purpose

createdBystring

ID of the user who created this role

lastUpdatedBystring

ID of the user who last updated this role

isCustomboolean

Indicates if this is a custom role (true) or a system role (false)

ownerType'provider'

Owner of the custom role. Set to provider for provider-owned (MSP) custom roles; omitted for organization-owned roles.

Changes

No recorded changes to this operation across all 1 revision of this API.