API Reference

Libraries

TypeScript

0.6.0

npm install @keycardai/api

Read Docs

Python

0.3.0

pip install keycardai_api

Read Docs

Go

0.6.0

go get -u 'github.com/keycardai/keycard-go@v0.0.1'

Read Docs

API Overview

Zones

List zones

GET/zones

Create zone

POST/zones

Get zone

GET/zones/{zoneId}

Update zone

PATCH/zones/{zoneId}

Delete zone

DELETE/zones/{zoneId}

ZonesApplications

List applications

GET/zones/{zoneId}/applications

Create application

POST/zones/{zoneId}/applications

Get application

GET/zones/{zoneId}/applications/{id}

Update application

PATCH/zones/{zoneId}/applications/{id}

Delete application

DELETE/zones/{zoneId}/applications/{id}

List application credentials

GET/zones/{zoneId}/applications/{id}/application-credentials

List application resources

GET/zones/{zoneId}/applications/{id}/resources

ZonesApplicationsDependencies

List application dependencies

GET/zones/{zoneId}/applications/{id}/dependencies

Add application dependency

PUT/zones/{zoneId}/applications/{id}/dependencies/{dependencyId}

Remove application dependency

DELETE/zones/{zoneId}/applications/{id}/dependencies/{dependencyId}

Get application dependency

GET/zones/{zoneId}/applications/{id}/dependencies/{dependencyId}

ZonesApplication Credentials

List application credentials

GET/zones/{zoneId}/application-credentials

Create application credential

POST/zones/{zoneId}/application-credentials

Get application credential

GET/zones/{zoneId}/application-credentials/{id}

Update application credential

PATCH/zones/{zoneId}/application-credentials/{id}

Delete application credential

DELETE/zones/{zoneId}/application-credentials/{id}

ZonesDelegated Grants

List delegated grants

GET/zones/{zoneId}/delegated-grants

Get delegated grant

GET/zones/{zoneId}/delegated-grants/{id}

Update delegated grant

PATCH/zones/{zoneId}/delegated-grants/{id}

Delete delegated grant

DELETE/zones/{zoneId}/delegated-grants/{id}

ZonesProviders

List providers

GET/zones/{zoneId}/providers

Create provider

POST/zones/{zoneId}/providers

Get provider

GET/zones/{zoneId}/providers/{id}

Update provider

PATCH/zones/{zoneId}/providers/{id}

Delete provider

DELETE/zones/{zoneId}/providers/{id}

ZonesResources

List resources

GET/zones/{zoneId}/resources

Create resource

POST/zones/{zoneId}/resources

Get resource

GET/zones/{zoneId}/resources/{id}

Update resource

PATCH/zones/{zoneId}/resources/{id}

Delete resource

DELETE/zones/{zoneId}/resources/{id}

ZonesSessions

List sessions

GET/zones/{zoneId}/sessions

Get session

GET/zones/{zoneId}/sessions/{id}

Update session

PATCH/zones/{zoneId}/sessions/{id}

Delete session

DELETE/zones/{zoneId}/sessions/{id}

ZonesUser Agents

List user agents

GET/zones/{zoneId}/user-agents

Get user agent

GET/zones/{zoneId}/user-agents/{id}

ZonesUsers

List users

GET/zones/{zoneId}/users

Get user

GET/zones/{zoneId}/users/{id}

ZonesMembers

Add organization user to zone

POST/zones/{zoneId}/members

List organization users in a zone

GET/zones/{zoneId}/members

Get organization user in a zone

GET/zones/{zoneId}/members/{organizationUserId}

Update organization user role in a zone

PATCH/zones/{zoneId}/members/{organizationUserId}

Remove member from zone

DELETE/zones/{zoneId}/members/{organizationUserId}

ZonesSecrets

Create

POST/zones/{zone_id}/secrets

List

GET/zones/{zone_id}/secrets

Delete

DELETE/zones/{zone_id}/secrets/{id}

Update

PATCH/zones/{zone_id}/secrets/{id}

Retrieve

GET/zones/{zone_id}/secrets/{id}

ZonesPolicy Schemas

List policy schemas

GET/zones/{zone_id}/policy-schemas

Get a policy schema by version

GET/zones/{zone_id}/policy-schemas/{version}

Set the default policy schema for a zone

PATCH/zones/{zone_id}/policy-schemas/{version}

ZonesPolicies

List policies in a zone

GET/zones/{zone_id}/policies

Create a new policy

POST/zones/{zone_id}/policies

Get a policy by ID

GET/zones/{zone_id}/policies/{policy_id}

Update a policy

PATCH/zones/{zone_id}/policies/{policy_id}

Archive a policy

DELETE/zones/{zone_id}/policies/{policy_id}

ZonesPoliciesVersions

List versions of a policy

GET/zones/{zone_id}/policies/{policy_id}/versions

Create a new immutable policy version

POST/zones/{zone_id}/policies/{policy_id}/versions

Get a specific policy version

GET/zones/{zone_id}/policies/{policy_id}/versions/{version_id}

Archive a policy version

DELETE/zones/{zone_id}/policies/{policy_id}/versions/{version_id}

ZonesPolicy Sets

List policy sets in a zone

GET/zones/{zone_id}/policy-sets

Create a new policy set

POST/zones/{zone_id}/policy-sets

Get a policy set by ID

GET/zones/{zone_id}/policy-sets/{policy_set_id}

Update a policy set

PATCH/zones/{zone_id}/policy-sets/{policy_set_id}

Archive a policy set

DELETE/zones/{zone_id}/policy-sets/{policy_set_id}

ZonesPolicy SetsVersions

List versions of a policy set

GET/zones/{zone_id}/policy-sets/{policy_set_id}/versions

Create a new immutable policy set version

POST/zones/{zone_id}/policy-sets/{policy_set_id}/versions

Get a specific policy set version

GET/zones/{zone_id}/policy-sets/{policy_set_id}/versions/{version_id}

Activate a policy set version

PATCH/zones/{zone_id}/policy-sets/{policy_set_id}/versions/{version_id}

Archive a policy set version

DELETE/zones/{zone_id}/policy-sets/{policy_set_id}/versions/{version_id}

List policy versions in a policy set version

GET/zones/{zone_id}/policy-sets/{policy_set_id}/versions/{version_id}/policies

Organizations

Create

POST/organizations

List

GET/organizations

Retrieve

GET/organizations/{organization_id}

Update

PATCH/organizations/{organization_id}

Exchange Token

POST/organizations/{organization_id}/token

List available roles

GET/organizations/{organization_id}/roles

List Identities

GET/organizations/{organization_id}/identities

OrganizationsUsers

List

GET/organizations/{organization_id}/users

Retrieve

GET/organizations/{organization_id}/users/{user_id}

Update

PATCH/organizations/{organization_id}/users/{user_id}

Delete

DELETE/organizations/{organization_id}/users/{user_id}

OrganizationsInvitations

Create

POST/organizations/{organization_id}/invitations

List

GET/organizations/{organization_id}/invitations

Delete

DELETE/organizations/{organization_id}/invitations/{invitation_id}

OrganizationsService Accounts

Create

POST/organizations/{organization_id}/service-accounts

List

GET/organizations/{organization_id}/service-accounts

Retrieve

GET/organizations/{organization_id}/service-accounts/{service_account_id}

Update

PATCH/organizations/{organization_id}/service-accounts/{service_account_id}

Delete

DELETE/organizations/{organization_id}/service-accounts/{service_account_id}

OrganizationsService AccountsCredentials

Create

POST/organizations/{organization_id}/service-accounts/{service_account_id}/credentials

List

GET/organizations/{organization_id}/service-accounts/{service_account_id}/credentials

Retrieve

GET/organizations/{organization_id}/service-accounts/{service_account_id}/credentials/{credential_id}

Update

PATCH/organizations/{organization_id}/service-accounts/{service_account_id}/credentials/{credential_id}

Delete

DELETE/organizations/{organization_id}/service-accounts/{service_account_id}/credentials/{credential_id}

OrganizationsSSO Connection

Enable

POST/organizations/{organization_id}/sso-connection

Retrieve

GET/organizations/{organization_id}/sso-connection

Update

PATCH/organizations/{organization_id}/sso-connection

Disable

DELETE/organizations/{organization_id}/sso-connection

Invitations

Retrieve

GET/invitations/{token}

Accept

POST/invitations/{token}/accept