Set all user permissions

POST

/api/v1/users/{username}/permissions/all

curl --request POST \
  --url https://osctrl.net/api/v1/users/example/permissions/all \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "access": { "admin": true, "carve": true, "query": true, "user": true } }'

Sets permissions across all environments for a user.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

username

required

string

Username

Request Body^required

Request body

Media typeapplication/json

object

access

object

admin

boolean

carve

boolean

query

boolean

user

boolean

Example^generated

{
  "access": {
    "admin": true,
    "carve": true,
    "query": true,
    "user": true
  }
}

Responses

200

OK

Media typeapplication/json

object

access

object

admin

boolean

carve

boolean

query

boolean

user

boolean

total

integer

updated

integer

Example^generated

{
  "access": {
    "admin": true,
    "carve": true,
    "query": true,
    "user": true
  },
  "total": 1,
  "updated": 1
}

400

Bad request

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

401

Unauthorized

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

403

Forbidden

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

404

Not found

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

409

Conflict

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

429

Too many requests

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

500

Internal server error

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

503

Service unavailable

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}