GuidesAPI Reference
API Reference

Create group

post
https://Use API Lookup for a base URL/groups

Create a group within the realm that is associated with the calling party. The calling party will be made a member and an administrator of the created group.


Access Control:

  • The calling principal must have "createGroup" action permission for the calling party "{realm}" in the "authorization" service.
  • The calling principal MUST NOT include a project scope.
Body Params
string
required

A user defined name for the group. The following characters are not allowed in the group name: control characters, non-breaking space, and * / < > \ |

string
length ≤ 500

An optional user defined description for the group.

The following characters are not allowed in the group name: control characters, non-breaking space, and * / < > \ |

Responses

422

A defined system limit would be violated if this action was completed. Example: 'MaxEntityRoles limit reached. Current value: 100. Maximum value: 100'

  • 422000 - LimitReached
  • This API works only with tokens that are not scoped to a project.

Updated 2 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 2 months ago