Delete a principal

A principal is an application or user identity that interacts with BigState. Principals are the subjects of authorization policies and the owners of API keys, tokens, and key pairs.

Deletes the principal identified by the principal query parameter. The request has no body, and a successful deletion returns 204 No Content.

Use Get a principal to verify the identifier before deletion. Afterward, List principals can confirm that the record is no longer returned.

An unknown identifier returns 404. For 401 or 403, check the x-api-key header and whether that key can delete the principal.

DELETE
{{host}}/v1/principal?principal={{principal}}
VERB:DELETE
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.

    {{apiKey}}
  • Content-TypeRequired

    MIME type of the request body.

    application/json
  • AcceptRequired

    MIME types the client can understand in the response.

    application/json

Need a session token? See Token sign in.

Response parameters#

  • 204Response body · no content

    The principal was deleted.

  • 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. Use the response `desc` field for the human-readable explanation.

    • descstring

      Human-readable description of the error.

Examples#

Delete a principal

Remove a principal by identifier (query only).

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

  --request DELETE \

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

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

  --header 'Accept: application/json'
GetList

© 2024 BigState