All URIs are relative to https://api.beamable.com
| Method | HTTP request | Description |
|---|---|---|
| api_auth_refresh_token_post | POST /api/auth/refresh-token | |
| api_auth_server_post | POST /api/auth/server | |
| api_auth_tokens_guest_post | POST /api/auth/tokens/guest | |
| api_auth_tokens_password_post | POST /api/auth/tokens/password | |
| api_auth_tokens_refresh_token_post | POST /api/auth/tokens/refresh-token |
models::AuthResponse api_auth_refresh_token_post(x_beam_scope, x_beam_gamertag, refresh_token_auth_request)
Generate a new access token for previously authenticated account. DEPRECATED: Use tokens/refresh-token instead.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| x_beam_scope | Option<String> | Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token | ||
| x_beam_gamertag | Option<String> | Override the playerId of the requester. This is only necessary when not using a JWT bearer token. | ||
| refresh_token_auth_request | Option<RefreshTokenAuthRequest> | RefreshTokenAuthRequest |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::ServerTokenResponse api_auth_server_post(x_beam_scope, x_beam_gamertag, server_token_auth_request)
Generate a new access token for a machine with a shared secret
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| x_beam_scope | Option<String> | Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token | ||
| x_beam_gamertag | Option<String> | Override the playerId of the requester. This is only necessary when not using a JWT bearer token. | ||
| server_token_auth_request | Option<ServerTokenAuthRequest> | ServerTokenAuthRequest |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::AuthResponse api_auth_tokens_guest_post(x_beam_scope, x_beam_gamertag, guest_auth_request)
Generate a new access token for a brand-new player.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| x_beam_scope | Option<String> | Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token | ||
| x_beam_gamertag | Option<String> | Override the playerId of the requester. This is only necessary when not using a JWT bearer token. | ||
| guest_auth_request | Option<GuestAuthRequest> | GuestAuthRequest |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::AuthResponse api_auth_tokens_password_post(x_beam_scope, x_beam_gamertag, password_auth_request)
Generate a new access token when given email and password credentials
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| x_beam_scope | Option<String> | Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token | ||
| x_beam_gamertag | Option<String> | Override the playerId of the requester. This is only necessary when not using a JWT bearer token. | ||
| password_auth_request | Option<PasswordAuthRequest> | PasswordAuthRequest |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::AuthResponse api_auth_tokens_refresh_token_post(x_beam_scope, x_beam_gamertag, refresh_token_auth_request)
Generate a new access token for previously authenticated account.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| x_beam_scope | Option<String> | Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token | ||
| x_beam_gamertag | Option<String> | Override the playerId of the requester. This is only necessary when not using a JWT bearer token. | ||
| refresh_token_auth_request | Option<RefreshTokenAuthRequest> | RefreshTokenAuthRequest |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]