CliQr is now part of Cisco Learn More About Cisco

Update Role

Details

API Details
Name

Update Role

Description

Updates any attribute in the configured Roles with the specified Role ID within the specified tenant.

MethodPUT
URIv1/tenants/tenantId/roles/roleId
CloudCenter ReleaseIntroduced in CloudCenter 4.0.
NotesFor additional context on <PORT> usage in the following example(s), see Base URI Format.
ESB Headeraction: update.tenants.tenantId.roles.roleId

Example

curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/roles/52"

Request Body

 

Response

 

Request Attributes

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String

Required

roleId
  • DescriptionUnique, system-generated identifier for a role
  • Type: String

Required

name
  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String

users (click for additional details)

If specified, provide the corresponding User ID.

group (click for additional details)
If specified, provide the corresponding Group ID .

objectPerms
  • Description: Identifies the permissions for this resource
  • Type: Array of name-value pairs

    objectType
    • Description: The name for each type of permission that a user or group can create, update, view, or delete a resource. See Permission Control >Tenant Owner Permission Nuances for additional details.
    • Type: Enumeration

    Required

    perms
    • Description: The permission level for each resource. See Permission Control >Tenant Owner Permission Nuances for additional details.
    • Type: Enumeration

Response Attributes

id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
resource
  • Description: Unique URL to access this resource
  • Type: String
perms (click for additional details)

name
  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

Required

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String

Required

objectPerms
  • Description: Identifies the permissions for this resource
  • Type: Array of name-value pairs

    objectType
    • Description: The name for each type of permission that a user or group can create, update, view, or delete a resource. See Permission Control >Tenant Owner Permission Nuances for additional details.
    • Type: Enumeration

    Required

    perms
    • Description: The permission level for each resource. See Permission Control >Tenant Owner Permission Nuances for additional details.
    • Type: Enumeration

 users (click for additional details)

 groups (click for additional details)

oobRole
  • Description: Indicates whether this role is a predefined system role for this tenant organization
    • true = this role is a predefined system role for this tenant organization
    • false = this role is not a predefined system role for this tenant organization
  • Type: Boolean
created
  • Description: The date that this resource was created (system generated)
  • Type: Long
lastUpdated
  • Description: Date that this resource was last updated. This attribute is the same as the lastUpdatedTime attribute.

  • Type: Long