Group API (2.17.0)
Download OpenAPI specification:Download
REST API for managing Group in the platform
Group details
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| uuid required | string |
Responses
Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "version": "v2"
}
]
}Edit Group
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| uuid required | string Group UUID |
Request Body schema: application/jsonrequired
| name required | string Name of the Group |
| description | string Description of the Group |
string Group contact email | |
Array of objects (RequestAttribute) List of Custom Attributes |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
], - "version": "v2"
}
]
}Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "version": "v2"
}
]
}Response samples
- 200
- 400
- 403
Content type
application/json
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "version": "v2"
}
]
}
]Create Group
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
| name required | string Name of the Group |
| description | string Description of the Group |
string Group contact email | |
Array of objects (RequestAttribute) List of Custom Attributes |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
], - "version": "v2"
}
]
}Response samples
- 201
- 400
- 403
- 404
Content type
application/json
{- "uuid": "string"
}Delete multiple Groups
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
Group UUIDs
Array
string
Responses
Request samples
- Payload
Content type
application/json
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]Response samples
- 400
- 403
Content type
application/json
{- "message": "Error message"
}