CliQr is now part of Cisco Learn More About Cisco

Update Group

Details

API Details
Name

Update Group

Description

Updates any attribute in the configured User Group with the specified Group ID within the specified tenant in this CloudCenter instance.

MethodPUT
URIv1/tenants/tenantId/groups/groupId
CloudCenter Release
  • Introduced in CloudCenter 4.0.
  • Enhanced in CloudCenter 4.2 to include the createdBySso attribute.
NotesFor additional context on <PORT> usage in the following example(s), see Base URI Format.
ESB Headeraction: update.tenants.tenantId.groups.groupId

Example

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

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.

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

Required

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

  • Type: String
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.

roles (click for additional details)

If specified, provide the corresponding Role ID.

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

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 details)

roles (click for additional details)

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

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