Token
Summary
The Token object encapsulates data related to user authentication tokens in the system.
These tokens represent specific API user accounts and can be used to authenticate API requests. It also indicates token validity through active and expires_at fields, ensuring secure and timely access control.
Each token is associated with a partner entity, which could be used for partner-specific access restrictions and operations.
One account can have many tokens. To get active token list use method Get token list.
To create new token use method Create new token.
Schema
Description
- _id: string
This is a unique identifier for the specific token.
- login: string
This refers to the login name of the user to whom this token belongs. The user would usually use this to log into the system.
- token: string
This represents the token string itself. The token could be generated as per some token generation algorithm in your system and could be used for authenticating the user.
- partner: string
The partner field is the identification of the partner entity in the context of the token. This could be used to associate the token with a specific partner.
- expires_at: string
The date and time indicating when the token will become invalid or expire. It's in the ISO 8601 format (yyyy-mm-ddThh: mm:ss.sssZ) in UTC.
- created_at: string
The date and time when the token was created. It's in the ISO 8601 format (yyyy-mm-ddThh:mm:ss.sssZ) in UTC.
- updated_at: string
The date and time when the token details were last updated. This, too, is given in ISO 8601 format (yyyy-mm-ddThh:mm: ss.sssZ) in UTC.