CliQr is now part of Cisco Learn More About Cisco

View Roles

Details

API Details
Name

View Roles

Description

Displays information for each User Role or for a specified user role within the specified tenant 

MethodGET
URI
  • v1/tenants/tenantId/roles
  • v1/tenants/tenantId/roles/roleId
CloudCenter ReleaseIntroduced in CloudCenter 4.0.
Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • The CloudCenter GET APIs display up to 20 entities in the listing by default. If you have more than 20 entities in your resource listing, use the pagination query parameters to view them beyond the first 20 entities returned by default. See the CloudCenter API Overview  > Pagination  section for additional context.
  • If you include a roleId to identify a role, the response includes information for that role only.
ESB Header
  • action: get.tenants.tenantId.roles
  • action: get.tenants.tenantId.roles.roleId

Example 1 – v1/tenants/tenantId/roles

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

Response

Example 2 – v1/tenants/tenantId/roles/roleId

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

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
roleId
  • DescriptionUnique, system-generated identifier for a role
  • Type: String

Response Attributes

roles
  • Description: Identifies information about roles
  • Type: Array of roles

    See pageResource or Pagination for additional context

    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