This endpoint accepts a request made with an API Key in the Authorization header and issues an ephemeral authentication token (expiring in 24 hours) in response.
Ephemeral Authentication Tokens
This endpoint accepts requests made with an API Key in the Authorization header and responds with an ephemeral authentication token (valid for 24 hours). This token can be used in subsequent API calls.
API Key Requirements
- You must have a valid API Key generated within your production or sandbox Stax account.
- The API Key should be included in the Authorization header as a Bearer token.
Usage Scenarios
Standard Authentication:
- If no URL parameters are passed, the endpoint reads your API Key from the Authorization header.
- Issues an ephemeral token with your Stax User as the JWT subject.
This method is not suitable for SSO capabilities because SSO requires specifying a particular user.
User-Specific Authentication:
- By passing
user_idoruser_emailas URL parameters, the endpoint issues an ephemeral token for the specified Stax User. - This token can then be used for SSO or authenticating API calls on behalf of that user.
Perfect for Single Sign-On implementations where you need to authenticate as a specific user.
Allows API calls to be made on behalf of the specified user using their permissions.
Key Benefits
Tokens expire in 24 hours for enhanced security.
Support for both standard and user-specific token generation.
Enable seamless single sign-on experiences.