BEbeyondidentity
Groups

Create a New Group

To create a group, send a POST request to /v1/tenants/$TENANT_ID/realms/$REALM_ID/groups. Values in the request body for read-only fields will be ignored.

post/v1/tenants/{tenant_id}/realms/{realm_id}/groups

Request

Path parameters

tenant_idstring required
Example:000176d94fd7b4d1

A unique identifier for a tenant.

realm_idstring required
Example:19a95130480dfa79

A unique identifier for a realm.

Request body

Example request

{
  "group": {
    "id": "81490afab171aef0",
    "realm_id": "7df92e4a38ba0993",
    "tenant_id": "0001b42d80372976",
    "display_name": "Realm Administrators",
    "description": "A group of realm administrators.",
    "create_time": "2022-03-14T03:42:52.905657Z",
    "update_time": "2022-06-14T05:55:23.823187Z"
  }
}

Response

The response will be a JSON object containing the standard attributes associated with a group.

idstring

A unique identifier for a group. This is automatically generated on creation. This field is immutable and read-only. This field is unique within the realm.

realm_idstring

A unique identifier for the group's realm. This is automatically set on creation. This field is immutable and read-only.

tenant_idstring

A unique identifier for the group's tenant. This is automatically set on creation. This field is immutable and read-only.

display_namestring

A human-readable name for the group. This name is used for display purposes.

descriptionstring

A free-form text field to describe a group.

create_timestring date-time

A time value given in ISO8601 combined date and time format that represents when the group was created. This is automatically generated on creation. This field is read-only.

update_timestring date-time

A time value given in ISO8601 combined date and time format that represents when the group was last updated. This is automatically updated when the group is updated. This field is read-only.

Example response

{
  "id": "81490afab171aef0",
  "realm_id": "7df92e4a38ba0993",
  "tenant_id": "0001b42d80372976",
  "display_name": "Realm Administrators",
  "description": "A group of realm administrators.",
  "create_time": "2022-03-14T03:42:52.905657Z",
  "update_time": "2022-06-14T05:55:23.823187Z"
}

Changes

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