Ga naar inhoud
buildinglinksbuildinglinks

Who is calling

GET
/api/v1/me
curl --request GET \
  --url https://example.com/api/v1/me \
  --cookie bl_%3Cslug%3E_session=%3Cbl_%3Cslug%3E_session%3E

The caller as the service knows it: name, roles and how it authenticated.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

OK.

Media typeapplication/json

Who is calling: a user of the identity provider, an API key, or the break-glass token.

object
subject
required

The subject at the identity provider, or the id of the API key.

string
name
required
string
email
string | null
roles
required

viewer, operator and/or admin.

Array<string>
auth
required

How the caller authenticated: oidc, api_key, token or setup.

string
scopes

What the credential may be used for: management, gateway, setup.

Array<string>
via

cli for a user working through bl (decisions #62); the audit log says so. The same person in the UI has None.

string | null

Example generated

{
  "subject": "example",
  "name": "example",
  "email": "example",
  "roles": [
    "example"
  ],
  "auth": "example",
  "scopes": [
    "example"
  ],
  "via": "example"
}

401

Section titled “401”

No valid session, DPoP-bound token or API key.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

403

Section titled “403”

The caller lacks the role this operation needs; or a change with the session cookie came from a page of another site (cross_site_request, decisions #83).

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}