Get principal

Returns principal (id), type, and name — the same JSON shape as each row in match.

GET
{{host}}/v1/principal?principal={{principal}}
VERB:GET
BASE URL:{{host}}/v1/principal
QUERY STRING:?principal={{principal}}

Query parameters#

  • principalstring
    Required

    Unique identifier of the principal in the URL.

    example: tram_client

Headers#

Send these headers with the request. Names are case-insensitive per HTTP rules.
  • x-api-keyRequired

    Your BigState API key.

    *provide api key here*
  • Content-TypeRequired

    MIME type of the request body.

    application/json
  • AcceptRequired

    MIME types the client can understand in the response.

    application/json

See authentication headers here.

Response parameters#

  • 200Response body · object

    Current principal: **`principal`** (id), **`type`**, and **`name`** (same shape as each match row).

    {

      "principal": "tram_client",

      "type": 1,

      "name": "Client for tram app"

    }
    • principalstring

      Unique identifier of this principal.

      example: tram_client
    • typenumber

      Principal kind: application (integration) or user.

      Values

      • 1 — application
      • 2 — user
    • namestring

      Human-readable name for this principal.

  • 401

    Unauthorized.

  • 403

    Access denied. The caller does not have sufficient rights to perform this operation.

  • 404

    No principal exists for the given identifier.

  • 400Response body · object

    Bad request.

    {

      "error": 6,

      "desc": "Invalid request"

    }
    • errornumber

      Numeric error code. See the error codes reference for the full list.

    • descstring

      Human-readable description of the error.

Examples#

Get principal

Fetch `principal`, `type`, and `name` by identifier (same shape as match rows).

curl https://api.bigstate.dev/v1/principal?principal=tram_client \

  --header 'x-api-key: YOUR_API_KEY' \

  --header 'Content-Type: application/json' \

  --header 'Accept: application/json'
UpsertDelete

© 2024 BigState