Execute user action

POST

/api/v1/users/{username}/{action}

curl --request POST \
  --url https://osctrl.net/api/v1/users/example/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "admin": true, "admin_access": true, "api": true, "carve_access": true, "email": "example", "environments": [ "example" ], "fullname": "example", "not_admin": true, "not_service": true, "password": "example", "query_access": true, "service": true, "user_access": true, "username": "example" }'

Creates, updates, deletes, or changes flags on a user.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

username

required

string

Username

action

required

string

User action

Request Body^required

Request body

Media typeapplication/json

object

admin

boolean

admin_access

boolean

api

boolean

carve_access

boolean

email

string

environments

Array<string>

fullname

string

not_admin

boolean

not_service

boolean

password

string

query_access

boolean

service

boolean

user_access

boolean

username

string

Example^generated

{
  "admin": true,
  "admin_access": true,
  "api": true,
  "carve_access": true,
  "email": "example",
  "environments": [
    "example"
  ],
  "fullname": "example",
  "not_admin": true,
  "not_service": true,
  "password": "example",
  "query_access": true,
  "service": true,
  "user_access": true,
  "username": "example"
}

Responses

200

OK

Media typeapplication/json

object

data

string

Example^generated

{
  "data": "example"
}

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"
}