Auth API
Manage organizations, members, invitations, Roles, OAuth applications, single sign-on and billing. Every request carries an access token: see Authentication.
Version 1.0.0
Base URL
https://auth.kapten.ioOrganizations
Organizations the caller belongs to.
- GETList the caller's organizations
/organizations - POSTCreate an organization
/organizations - GETGet an organization
/organizations/{organizationId} - PATCHUpdate an organization
/organizations/{organizationId} - DELETEDelete an organization
/organizations/{organizationId}
Members
Members of an organization and their Roles.
- GETList members
/organizations/{organizationId}/members - DELETERemove a member
/organizations/{organizationId}/members/{userId} - PUTSet a member's Roles
/organizations/{organizationId}/members/{userId}
Invitations
Invitations to join an organization.
- GETList pending invitations
/organizations/{organizationId}/invitations - POSTInvite someone by email
/organizations/{organizationId}/invitations - DELETECancel a pending invitation
/organizations/{organizationId}/invitations/{invitationId} - POSTAccept an invitation
/invitations/accept
Roles and permissions
Roles, their scoped grants, and permission checks.
- GETList Roles
/organizations/{organizationId}/roles - POSTCreate a custom Role
/organizations/{organizationId}/roles - PATCHRename a custom Role or replace its Grants
/organizations/{organizationId}/roles/{roleId} - DELETEDelete a custom Role
/organizations/{organizationId}/roles/{roleId} - POSTCheck the caller's Permissions
/organizations/{organizationId}/permission-checks - GETGet the Permission catalog
/permissions
OAuth applications
Machine clients of an organization, using the client credentials grant.
- GETList OAuth applications
/organizations/{organizationId}/oauth-clients - POSTCreate an OAuth application
/organizations/{organizationId}/oauth-clients - GETGet an OAuth application
/organizations/{organizationId}/oauth-clients/{clientId} - PATCHUpdate an OAuth application
/organizations/{organizationId}/oauth-clients/{clientId} - DELETERevoke an OAuth application
/organizations/{organizationId}/oauth-clients/{clientId} - POSTRegister a public key
/organizations/{organizationId}/oauth-clients/{clientId}/keys - DELETERevoke a public key
/organizations/{organizationId}/oauth-clients/{clientId}/keys/{keyId} - POSTCreate a client secret
/organizations/{organizationId}/oauth-clients/{clientId}/secrets - DELETERevoke a client secret
/organizations/{organizationId}/oauth-clients/{clientId}/secrets/{secretId}
Single sign-on
The organization’s OpenID Connect identity provider.
- GETGet the organization's identity provider
/organizations/{organizationId}/sso - PUTCreate or replace the organization's identity provider
/organizations/{organizationId}/sso - DELETERemove the organization's identity provider
/organizations/{organizationId}/sso - POSTVerify an email domain of the identity provider
/organizations/{organizationId}/sso/domains/{domain}/verify
Billing
The organization’s subscription.
- GETList the subscription plans
/organizations/{organizationId}/billing/plans - GETGet the organization's current subscription
/organizations/{organizationId}/billing/subscription - POSTCancel the subscription
/organizations/{organizationId}/billing/subscription/cancel - POSTUndo a scheduled cancellation
/organizations/{organizationId}/billing/subscription/resume - POSTEstimate the recurring invoice
/organizations/{organizationId}/billing/preview - POSTSubscribe, or change the plan or seats
/organizations/{organizationId}/billing/checkout - POSTOpen the Stripe Customer Portal
/organizations/{organizationId}/billing/portal
Passkeys
The caller’s passkeys.
- GETList the caller's passkeys
/passkeys - PATCHRename a passkey
/passkeys/{passkeyId} - DELETERevoke a passkey
/passkeys/{passkeyId}
Audit log
Changes made to the organization, its members and Roles.
Discovery
OpenID Connect discovery document of the authorization server.
Token keys
Public keys that verify access tokens.