Create Custom Group In Organization By Organization Id Using POST

• Organization Groups

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

"CreateCustomGroupRequest Object"

string As ^[^@]+$

name

Required

Constraints: minLength: 0 maxLength: 200

Name of the custom group to be created.

string

description

Optional

Constraints: minLength: 0 maxLength: 500

Description of the custom group to be created.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Hide Details

OK

Returns IdDto of type(s) application/json

{
    "id": "string"
}

string

id

Optional

The unique identifier of the resource.

400

Hide Details

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

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

401

Hide Details

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

403

Hide Details

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

404

Hide Details

Organization with this identifier is not found.

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

409

Hide Details

The Group with that name already exists

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

429

Hide Details

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

500

Hide Details

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups
                

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Organization Groups Operations

POST

Add Users To Custom Group In Organization By Organization Id And Group Id Using POST

DELETE

Remove Users From Custom Group In Organization By Organization Id And Group Id And User Ids Using DELETE

GET

Get Users In Group Within Organization By Organization Id And Group Id Using GET

PATCH

Update Group Details In Organization By Organization Id And Group Id Using PATCH

GET

Get Group In Organization By Organization Id And Group Id Using GET

PATCH

Update Group Roles On Organization By Organization Id And Group Id Using PATCH

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

POST

Create Custom Group In Organization By Organization Id Using POST

DELETE

Remove Groups From Organization By Organization Id And Groups Id Using DELETE

GET

Get Organization Groups By Organization Id Using GET

POST

Search Groups Within Organization By Organization Id And Group Roles Using POST