Get user

GET

/api/v1/users/{username}

curl --request GET \
  --url https://osctrl.net/api/v1/users/example \
  --header 'Authorization: <Authorization>'

Returns an API user by username.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

username

required

string

Username

Responses

200

OK

Media typeapplication/json

object

admin

boolean

auth_source

AuthSource is empty for the password-login path (the default) and “oidc” for users JIT-provisioned through the federated callback. Surfaced so the SPA Users page can show an “OIDC” badge alongside the existing admin/service labels.

string

created_at

string

email

string

environment_id

integer

fullname

string

id

integer

service

boolean

token_expire

string

updated_at

string

username

string

uuid

string

Example^generated

{
  "admin": true,
  "auth_source": "example",
  "created_at": "example",
  "email": "example",
  "environment_id": 1,
  "fullname": "example",
  "id": 1,
  "service": true,
  "token_expire": "example",
  "updated_at": "example",
  "username": "example",
  "uuid": "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"
}