Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13217260568.5 KB
userRoles

Updates an existing user role.

put/userprofiles/{+profileId}/userRoles

Path parameters

profileIdstring required

User profile ID associated with this request.

Request body

subaccountIdstring int64

Subaccount ID of this user role. This is a read-only field that can be left blank.

idstring int64

ID of this user role. This is a read-only, auto-generated field.

accountIdstring int64

Account ID of this user role. This is a read-only field that can be left blank.

namestring

Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.

parentUserRoleIdstring int64

ID of the user role that this user role is based on or copied from. This is a required field.

defaultUserRoleboolean

Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.

kindstring

Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".

Response

Successful response