Post Post Group
Creates a group in the system directory
Request
URI
POST
https://{api_host}//SAAS/jersey/manager/api/scim/Groups
COPY
Query Parameters
string
attributes
Optional
list of attributes to return, separated by comma. When specified, the returned created group will only contain the minimal set of group attributes plus the attributes or sub-attributes explicitly requested
attributes example
urn:scim:schemas:extension:workspace:1.0:domain,groupName
Request Body
the group resource to be created as a JSON string
SdkGroupResource of type(s) application/json
Required
{
"displayName": "string",
"resourceDescriptor": {
"endpoint": "string",
"description": "string",
"name": "string",
"attributeSchemas": [
"string"
],
"strictMode": false,
"scimObject": {
"schemas": [
"string"
]
},
"meta": {
"lastModified": "string",
"version": "string",
"location": "string",
"created": "string"
},
"externalId": "string",
"attributes": [
{
"subAttributes": [
"AttributeDescriptor Object"
],
"description": "string",
"canonicalValues": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"dataType": "string",
"required": false,
"caseExact": false,
"name": "string",
"readOnly": false,
"multiValuedChildName": "string",
"multiValued": false,
"schema": "string"
}
],
"schema": "string",
"id": "string",
"resourceDescriptor": "ResourceDescriptor Object"
},
"urn:scim:schemas:extension:workspace:1.0": {
"distinguishedName": "CN=all-admin-users,CN=Users,DC=acme,DC=com",
"internalGroupType": "EXTERNAL",
"domain": "acme.com",
"description": "The group for all admin users",
"compositionRules": "{\n \"addedUserIds\" : [ ],\n \"excludedUserIds\" : [ ],\n \"rule\" : {\n \"type\" : \"internalGroup\",\n \"groupId\" : \"53cc45f9-2e21-4fa4-ae81-32e6fb15bd91\"\n }\n}",
"userStoreUuid": "acme.com",
"parents": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"compositionRulesV2": false,
"email": "[email protected]"
},
"scimObject": {
"schemas": [
"string"
]
},
"meta": {
"lastModified": "string",
"version": "string",
"location": "string",
"created": "string"
},
"externalId": "string",
"members": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"id": "string",
"schemas": [
"string"
]
}string
displayName
Optional
displayName
urn:scim:schemas:extension:workspace:1.0
Optional
urn:scim:schemas:extension:workspace:1.0
string
externalId
Optional
externalId
string
id
Optional
id
array of string
schemas
Optional
The set of schemas that are currently contributing attributes to this group
Responses
201
successful operation
Returns SdkGroupResource of type(s) application/json
{
"displayName": "string",
"resourceDescriptor": {
"endpoint": "string",
"description": "string",
"name": "string",
"attributeSchemas": [
"string"
],
"strictMode": false,
"scimObject": {
"schemas": [
"string"
]
},
"meta": {
"lastModified": "string",
"version": "string",
"location": "string",
"created": "string"
},
"externalId": "string",
"attributes": [
{
"subAttributes": [
"AttributeDescriptor Object"
],
"description": "string",
"canonicalValues": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"dataType": "string",
"required": false,
"caseExact": false,
"name": "string",
"readOnly": false,
"multiValuedChildName": "string",
"multiValued": false,
"schema": "string"
}
],
"schema": "string",
"id": "string",
"resourceDescriptor": "ResourceDescriptor Object"
},
"urn:scim:schemas:extension:workspace:1.0": {
"distinguishedName": "CN=all-admin-users,CN=Users,DC=acme,DC=com",
"internalGroupType": "EXTERNAL",
"domain": "acme.com",
"description": "The group for all admin users",
"compositionRules": "{\n \"addedUserIds\" : [ ],\n \"excludedUserIds\" : [ ],\n \"rule\" : {\n \"type\" : \"internalGroup\",\n \"groupId\" : \"53cc45f9-2e21-4fa4-ae81-32e6fb15bd91\"\n }\n}",
"userStoreUuid": "acme.com",
"parents": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"compositionRulesV2": false,
"email": "[email protected]"
},
"scimObject": {
"schemas": [
"string"
]
},
"meta": {
"lastModified": "string",
"version": "string",
"location": "string",
"created": "string"
},
"externalId": "string",
"members": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"id": "string",
"schemas": [
"string"
]
}string
displayName
Optional
displayName
urn:scim:schemas:extension:workspace:1.0
Optional
urn:scim:schemas:extension:workspace:1.0
string
externalId
Optional
externalId
string
id
Optional
id
array of string
schemas
Optional
The set of schemas that are currently contributing attributes to this group
400
The specified attributes are invalid or the displayName of the group to be created is missing or invalid
Operation doesn't return any data structure
409
A group with the same displayName already exists
Operation doesn't return any data structure
On This Page
Scim Operations
DELETE
Delete Delete Group
DELETE
Delete Delete User
GET
Get Get Group
GET
Get Get Groups
GET
Get Get Role
GET
Get Get Roles
GET
Get Get Schemas
GET
Get Get User
GET
Get Get Users
PATCH
Patch Patch Group
PATCH
Patch Patch Role
PATCH
Patch Patch User
POST
Post Find Groups
POST
Post Find Users
POST
Post Post Group
POST
Post Post User