Create Group | VMware Identity Broker

Create Group

This endpoint is responsible for creating a new group. For more information, check the specification: https://tools.ietf.org/html/rfc7644#section-3.3.

Request

URI

POST

https://{api_host}//usergroup/t/{tenant}/scim/v2/Groups

COPY

Path Parameters

string

tenant

Required

The VMware Identity Services tenant ID

tenant example

my-tenant

Request Body

GroupMedia of type(s) application/scim+json

Required

{
    "members": [
        {
            "value": "42dc6b2c-4517-4e88-b1a7-79a1a1f88b5b",
            "$ref": "https://example.com/v2/User/42dc6b2c-4517-4e88-b1a7-79a1a1f88b5b",
            "display": "Example User"
        }
    ],
    "displayName": "Example Group",
    "id": "string",
    "externalId": "string",
    "meta": {
        "location": "string",
        "version": "string",
        "lastModified": "string",
        "resourceType": "string",
        "created": "string"
    },
    "schemas": [
        "string"
    ]
}

array of GroupMemberMedia

members

Optional

A list of members of the group

string

displayName

Required

A human-readable name for the group

string

Optional

The unique identifier of the SCIM resource

string

externalId

Optional

The SCIM resource external identifier

MetaMedia

meta

Optional

meta

array of string

schemas

Optional

The SCIM resource schema URIs

Authentication

This operation uses the following authentication methods.

basic_auth

admin

Responses

200

The group was successfully created.

Returns GroupMedia of type(s) application/scim+json

{
    "members": [
        {
            "value": "42dc6b2c-4517-4e88-b1a7-79a1a1f88b5b",
            "$ref": "https://example.com/v2/User/42dc6b2c-4517-4e88-b1a7-79a1a1f88b5b",
            "display": "Example User"
        }
    ],
    "displayName": "Example Group",
    "id": "string",
    "externalId": "string",
    "meta": {
        "location": "string",
        "version": "string",
        "lastModified": "string",
        "resourceType": "string",
        "created": "string"
    },
    "schemas": [
        "string"
    ]
}

array of GroupMemberMedia

members

Optional

A list of members of the group

string

displayName

Required

A human-readable name for the group

string

Optional

The unique identifier of the SCIM resource

string