Skip to main content
POST
/
v2
/
session
/
apps
/
{appID}
/
config
/
groups
Create group
curl --request POST \
  --url https://api.prelude.dev/v2/session/apps/{appID}/config/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "scopes": [
    "<string>"
  ]
}
'
{
  "name": "<string>",
  "scopes": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
appID
string
required

The id of the app the request refers to. An application's unique identifier.

Examples:

"54e9ujn"

"fvua38g"

Body

application/json
​
name
string
required

A group name, unique per application.

Maximum string length: 64
Pattern: ^[a-zA-Z0-9\-_]+$
Example:

"admins"

​
scopes
string[]
required

The scopes the group owns. Each must be one of the app's allowed scopes.

A scope identifier.

Pattern: ^[a-zA-Z0-9.\-_:]+$

Response

Created

​
name
string
required

A group name, unique per application.

Maximum string length: 64
Pattern: ^[a-zA-Z0-9\-_]+$
Example:

"admins"

​
scopes
string[]
required
Example:
["read", "write"]
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required