Grant an administrative principal

const options = {
  method: 'POST',
  headers: {cookie: 'overlay_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({userId: '<string>'})
};

fetch('https://getoverlay.io/api/v1/admin/principals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'POST',
  headers: {cookie: 'overlay_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({userId: '<string>'})
};

fetch('https://getoverlay.io/api/v1/admin/principals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://getoverlay.io/api/v1/admin/principals \
  --header 'Content-Type: application/json' \
  --cookie overlay_session= \
  --data '
{
  "userId": "<string>"
}
'

"<unknown>"

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

POST

api

admin

principals

Grant an administrative principal

const options = {
  method: 'POST',
  headers: {cookie: 'overlay_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({userId: '<string>'})
};

fetch('https://getoverlay.io/api/v1/admin/principals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'POST',
  headers: {cookie: 'overlay_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({userId: '<string>'})
};

fetch('https://getoverlay.io/api/v1/admin/principals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://getoverlay.io/api/v1/admin/principals \
  --header 'Content-Type: application/json' \
  --cookie overlay_session= \
  --data '
{
  "userId": "<string>"
}
'

"<unknown>"

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

Authorizations

overlay_session

string

required

Signed httpOnly browser session cookie.

Body

application/json

userId

string

required

Minimum string length: 1

role

enum<string>

required

Available options:

admin,

auditor,

billing_admin,

support

reason

string

Response

Successful response. Stable response schemas are documented in workflow guides when available.

Response shape is route-specific and may be backed by @overlay/app-core contracts.

List administrative principals Revoke an administrative principal