BAballerina-platform
Groups Endpoint

Create Group

This API creates a group and returns the details of the created group including its unique ID.

  • <b>Scope(Permission) required:</b> internal_group_mgt_create

  • <b>Flow type:</b> Client Credentials OAuth Flow

post/Groups

Request

Query parameters

attributesstring

SCIM defined attributes parameter.

excludedAttributesstring

SCIM defined excludedAttribute parameter.

Request body

schemasstring[] required
displayNamestring required
membersobject[]

Example request

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "displayName": "DEFAULT/manager",
  "members": [
    {
      "value": "008bba85-451d-414b-87de-c03b5a1f4217",
      "display": "kim"
    }
  ]
}

Response

Valid group is created

displayNamestring
schemasstring[]
idstring

Example response

{
  "displayName": "DEFAULT/manager",
  "meta": {
    "created": "2019-08-26T14:27:36.000Z",
    "location": "https://api.asgardeo.io/t/{org-name}/scim2/Groups/7bac6a86-1f21-4937-9fb1-5be4a93ef469",
    "lastModified": "2019-08-26T14:27:36.000Z",
    "resourceType": "Group"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "7bac6a86-1f21-4937-9fb1-5be4a93ef469",
  "members": [
    {
      "$ref": "https://api.asgardeo.io/t/{org-name}/scim2/Users/3a12bae9-4386-44be-befd-caf349297f45",
      "display": "kim",
      "value": "008bba85-451d-414b-87de-c03b5a1f4217"
    }
  ],
  "roles": [
    {
      "$ref": "https://api.asgardeo.io/t/{org-name}/scim2/Roles/4645709c-ea8c-4495-8590-e1fa0efe3de0",
      "display": "loginRole",
      "value": "4645709c-ea8c-4495-8590-e1fa0efe3de0"
    }
  ]
}

Changes

No recorded changes to this operation across all 4 revisions of this API.