CliQr is now part of Cisco Learn More About Cisco

View Groups

Details

API Details
Name

View Groups

Description

Displays information for all Groups or for a specified user group within the specified tenant.

MethodGET
URI
  • v1/tenants/tenantId/groups
  • v1/tenants/tenantId/groups/groupId
CloudCenter Release
  • Introduced in CloudCenter 4.0.
  • Enhanced in CloudCenter 4.2 to include the createdBySso attribute.
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 groupId to identify a user group, the response includes information for that user group only.
ESB Header
  • action: get.tenants.tenantId.groups
  • action: get.tenants.tenantId.groups.groupId

Example – v1/tenants/tenantId/groups/groupId

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

Response

 

Example – v1/tenants/tenantId/groups/groupId

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

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

groupId
  • DescriptionUnique, system-generated identifier for the group
  • Type: String

Response Attributes

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

  • Type: String
groups
  • Description: Identifies details about each user group
  • Type: Array of groups

    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

    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

     users (click for additional context)

     roles (click for additional context)

    created
    • Description: The date that this resource or favorite was created (system generated). This is a read-only attribute and cannot be configured.
    • Type: Long
    lastUpdated
    • Description: Date that this resource was last updated. This attribute is the same as the lastUpdatedTime attribute.

    • Type: Long

    createdBySso
    • Description: Identifies if this group was automatically assigned by CloudCenter based on an SSO implementation. See SSO for additional context.

      • true = This group was automatically assigned by CloudCenter.
      • false = Default. This group was not assigned by CloudCenter.
    • Type: Boolean