For the complete documentation index, see llms.txt. This page is also available as Markdown.

Groups

List Groups

get
Authorizations
AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Query parameters
filterstringOptional

The following filters are available:

  • id with comparison operators eq co sw ew
  • displayName with comparison operators eq co sw ew

Multiple filters can be used with the logical operators and or

Example: id eq "cksq4ybpq104zwgwh2gd1vvha"
startIndexintegerOptional

Index of the first query result

Default: 1
countinteger · min: 1 · max: 500Optional

Maximun numer of query results per page

Default: 500
sortBystring · enumOptionalDefault: idPossible values:
sortOrderstring · enumOptionalDefault: ascendingPossible values:
Responses
200Success
application/json
totalResultsintOptionalExample: 2
startIndexintOptionalExample: 1
itemsPerPageintOptionalExample: 500
get/Groups

Create Group

post
Authorizations
AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Body
schemasstring[]Optional
namestringRequiredExample: Admin
descriptionstringOptionalExample: Access to admin features
Responses
201

See Get Group. Store the response's id and use this in future requests related to this group.

No content

post/Groups

No content

Get Group

get
Authorizations
AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters
idstringRequired
Responses
200Success
application/json
idstringOptional
displayNamestringOptional
namestringOptional
descriptionstringOptional
get/Groups/{id}

Overwrite Group

put
Authorizations
AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters
idstringRequired
Body
namestringRequiredExample: Admin
descriptionstringOptionalExample: Access to admin features
Responses
200

See Get Group

No content

put/Groups/{id}

No content

Delete Group

delete
Authorizations
AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters
idstringRequired
Responses
204

Complete

No content

delete/Groups/{id}

No content

Update Group

patch
Authorizations
AuthorizationstringRequired

Authorization: Bearer {AuthorizationToken}

Path parameters
idstringRequired
Body
Responses
200

See Get Group

No content

patch/Groups/{id}

No content

Last updated

Was this helpful?