Create Custom Group In Organization By Organization Id Using POST

Create Custom Group In Organization By Organization Id Using POST

Create a new custom group in organization.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Admin ✔️ ✔️
Organization Owner ✔️ ✔️
Request
URI
POST
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups
COPY
Path Parameters
string
orgId
Required

Unique identifier (GUID) of the organization.

Request Body
CreateCustomGroupRequest of type(s) application/json
Required 
{
    "description": "string",
    "name": "string"
}
string
description
Optional

Description of the custom group to be created.

string As ^[^@]+$
name
Required

Name of the custom group to be created.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns IdDto of type(s) application/json 
{
    "id": "string"
}
string
id
Optional

The unique identifier of the resource.


400

Missing required parameters or invalid parameters in request body returns a 400 (bad request) status code

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


404

Organization with this identifier is not found.

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


409

The Group with that name already exists

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


On This Page
Organization Groups Operations
POST
Add Users To Custom Group In Organization By Organization Id And Group Id Using POST
POST
Create Custom Group In Organization By Organization Id Using POST
GET
Get Group In Organization By Organization Id And Group Id Using GET
GET
Get Group Roles On Organization By Organization Id And Group Id Using GET
GET
Get Nested Enterprise Groups From Custom Group By Organization Id And Group Id Using GET
GET
Get Organization Groups By Organization Id Using GET
GET
Get Users In Group Within Organization By Organization Id And Group Id Using GET
DELETE
Remove Groups From Organization By Organization Id And Groups Id Using DELETE
DELETE
Remove Users From Custom Group In Organization By Organization Id And Group Id And User Ids Using DELETE
POST
Search Groups Within Organization By Organization Id And Group Roles Using POST
PATCH
Update Group Details In Organization By Organization Id And Group Id Using PATCH
PATCH
Update Group Roles On Organization By Organization Id And Group Id Using PATCH