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(AuthIssueAccessTokenParams**kwargs) -> AuthIssueAccessTokenResponse
POST/v1/auth/access-tokens
ModelsExpand Collapse
Literal["employer", "employee"]
  • employer - employer
  • employee - employee
One of the following:
"employer"
"employee"
class AuthIssueAccessTokenResponse: …
access_token: str

The issued access token (vit_at_*)

expires_in: int

Token lifetime in seconds

token_type: str

Token type, always ‘Bearer’

bound_entity: Optional[BoundEntity]

Entity the token is bound to, if any

id: str

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

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