Permissions

Permissions offer fine-grained control over your Application's access to different resources within your Tenant. We suggest minimizing the scope of your Applications, and to not share Applications across your internal services.

Permissions are associated with every Application and can be configured when you create an Application or update an Application.

Every API endpoint will document the required permissions needed to perform the operation against the endpoint.

Treat Management API keys that hold application:create or application:update as administrative credentials. These permissions control which Applications exist in your Tenant and what each one is allowed to do. Grant them to as few keys as possible, restrict them to the automation that provisions Applications, store them with the same care as your Private API keys, and rotate them if they are ever exposed.

List Permissions

Gets the list of all supported permissions.

GET

https://api.basistheory.com/permissions

Request

cURL

curl "https://api.basistheory.com/permissions" \
  -H "BT-API-KEY: <API_KEY>"

Node

await client.permissions.list();

JavaScript (legacy)

import { BasisTheory } from "@basis-theory/basis-theory-js";

const bt = await new BasisTheory().init("<API_KEY>");

const permissions = await bt.permissions.list();

C#

await client.Permissions.ListAsync(new PermissionsListRequest());

Java

new PermissionsClient(ClientOptions.builder().build()).list();

Python

client.permissions.list()

Go

applicationType := "private"
permissions, err := client.Permissions.List(ctx, &basistheory.PermissionsListRequest{
ApplicationType: &applicationType,
})

Query Parameters

Parameter	Required	Type	Default	Description
application_type	false	string	null	Application type to filter permissions by

Response

Returns an array of permission objects. Returns an error if permissions could not be retrieved.

[
  {
    "type": "token:read",
    "description": "Read tokens",
    "application_types": [
      "private"
    ]
  },
  {...},
  {...}
]

Permission Object

Attribute	Type	Description
type	string	Permission type referenced by Basis Theory API endpoints
description	string	Description of the permission
application_types	array	List of application types that can assign the permission