Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference

Auth

Issue short-lived access tokens for scoped API access

Issue access token
auth.issue_access_token(**kwargs) -> AuthIssueAccessTokenResponse { access_token, expires_in, token_type, bound_entity }
POST/v1/auth/access-tokens
ModelsExpand Collapse
Type = :employer | :employee
  • employer - employer
  • employee - employee
One of the following:
:employer
:employee
class AuthIssueAccessTokenResponse { access_token, expires_in, token_type, bound_entity }
access_token: String

The issued access token (vit_at_*)

expires_in: Integer

Token lifetime in seconds

token_type: String

Token type, always ‘Bearer’

bound_entity: { id, type}

Entity the token is bound to, if any

id: String

Prefixed entity ID the token is bound to (empr_* or empl_*)

type: Type
  • employer - employer
  • employee - employee
One of the following:
:employer
:employee