Create Group

Details

API Details
Name

Create Group

Description
MethodPOST
URIv1/tenants/tenantId/groups
CloudCenter Release
  • Introduced in CloudCenter 4.0.
  • Enhanced in CloudCenter 4.2 to include the createdBySso attribute.
Notes
ESB Headeraction: create.tenants.tenantId.groups

Example

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

Request Body

{
    "tenantId": "1",
    "name": "Development ",
    "description": "Development",
    "users": [
        {
            "id": "11"
        },
        {
            "id": "15"
        }
    ],
    "roles": [
        {
            "id": "3"
        }
    ]
}

Response

{
    "id": "5",
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/groups/5",
    "perms": [],
    "name": "Development 3",
    "description": "Development",
    "tenantId": "1",
    "users": [
        {
            "id": "15",
            "resource": null,
            "perms": [],
            "username": null,
            "password": null,
            "enabled": false,
            "type": null,
            "firstName": null,
            "lastName": null,
            "companyName": null,
            "tenantId": null,
            "emailAddr": null,
            "emailVerified": false,
            "phoneNumber": null,
            "externalId": null,
            "accessKeys": null,
            "disableReason": null,
            "accountSource": null,
            "status": null,
            "detail": null,
            "activationData": null,
            "created": 0,
            "lastUpdated": 0,
            "coAdmin": false
        },
        {
            "id": "11",
            "resource": null,
            "perms": [],
            "username": null,
            "password": null,
            "enabled": false,
            "type": null,
            "firstName": null,
            "lastName": null,
            "companyName": null,
            "tenantId": null,
            "emailAddr": null,
            "emailVerified": false,
            "phoneNumber": null,
            "externalId": null,
            "accessKeys": null,
            "disableReason": null,
            "accountSource": null,
            "status": null,
            "detail": null,
            "activationData": null,
            "created": 0,
            "lastUpdated": 0,
            "coAdmin": false
        }
    ],
    "roles": [
        {
            "id": "3",
            "resource": null,
            "perms": [],
            "name": null,
            "description": null,
            "tenantId": "0",
            "objectPerms": [],
            "users": [],
            "groups": [],
            "oobRole": false,
            "created": 0,
            "lastUpdated": 0
        }
    ],
    "created": 1449332534090,
    "lastUpdated": 1439337703457
    "createdBySso": false
}

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
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)
roles (click for additional details)

 

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