Get Portal Token Details
POST
/users/v1/portaltoken/details
Request Body required
object
grant_type
required
The grant type used to authenticate the portal tokens
string
portal_access_token
required
Token or secret used to authenticate the provided grant type
string
Responses
200
Successful Response
object
key
additional properties
string
403
Error Codes:
internal_error- An internal error occurred. The request may succeed if retried. If not, contact an administrator.no_redirects_configured- No redirect urls setup for oauth.redirect_uri_does_not_match- Redirect URI does not match a configured value.error_occurred_during_exchange- An error occurred while exchanging a code for token.failed_to_verify_state- Failed to verify the state associated with the request.failed_to_save_state- Error occurred saving the state.failed_to_save_tokens- Problem saving tokens. Contact an administratortoo_many_users- Account has too many users associated with it. Contact an administratoruser_auth_restricted- Authentication for this user has been restricteduser_needs_agreements- User has not accepted all required agreements. See response for list of agreements requirederror_retrieving_player_results- Error retrieving player resultsfailed_to_retrieve_roles- Failed to retrieve rolesamazon_disabled- Amazon authentication is currently disabledamazon_token_empty- Amazon access token is emptyamazon_invalid_access_token- Amazon access token is invalidamazon_token_exchange_failed- Problem exchanging code for token with Amazonanon_disabled- Anon authentication is currently disabledanon_token_empty- Anon access token is emptyapple_disabled- Apple authentication is currently disabledapple_token_empty- Apple access token is emptyapple_failed_key_lookup- Failed to retrieve keys from Appleapple_token_exchange_failed- Problem exchanging code for token with Appleapple_token_key_not_valid- public key not foundapple_token_not_valid- Apple access token is not validauthorization_code_not_found- Authorization code not found or expiredbasic_disabled- Basic authentication is currently disabledbasic_token_empty- Basic access token is emptybasic_auth_incorrect_format- Basic auth should be formatted likeUSERNAME:PASSWORDbasic_auth_credentials_not_found- Basic auth credentials not foundepic_disabled- Epic authentication is currently disabledepic_token_empty- Epic access token is emptyepic_v1_token_key_id_invalid- Epic v1 token contains an invalid key idepic_v1_token_invalid- Epic v1 token is invalidepic_v2_keys_not_available- Epic v2 keys are not available. Please contact an administratorepic_v2_token_invalid- Epic v2 token is invalidepic_oauth_token_exchange_failed- Problem exchanging code for token with Epicgoogle_disabled- Google authentication is currently disabledgoogle_token_empty- Google access token is emptygoogle_keys_not_available- Google keys are not available. Please contact an administratorgoogle_token_not_valid- Google access token is not validgoogle_token_exchange_failed- Problem exchanging code for token with Googlenintendo_disabled- Nintendo authentication is currently disablednintendo_token_empty- Nintendo access token is emptynintendo_access_token_not_valid- Nintendo access token is not validnintendo_no_environment_matches_env_id- Nintendo environment not found for given environment IDnintendo_retrieve_client_credentials_failed- Problem retrieving client credentials from Nintendo. This commonly occurs while converting between NAID and PPID.nintendo_ppid_conversion_failed- error during PPID conversionnintendo_ppid_conversion_too_many_accounts_found- too many accounts found during PPID conversionnintendo_ppid_conversion_no_accounts_found- no accounts found during PPID conversionnintendo_ppid_missing- PPID is missing for usernintendo_ppid_key_not_valid- Nintendo access token key is not validnintendo_service_key_url_not_found- Nintendo service key url not found. This usually indicates that the corresponding Nintendo environment has a mismatch between Nintendo account URL and Nintendo Service Account URL.nintendo_service_access_token_not_valid- Nintendo service access token is not validnintendo_service_access_token_for_wrong_app- Nintendo service access token is for the wrong appnintendo_oauth_env_not_found- Nintendo oauth environment not found. Check that the environment is configured correctly.nintendo_token_exchange_failed- Problem exchanging code for token with Nintendops4_v1_disabled- PS4 v1 authentication is currently disabledps4_v1_token_empty- PS4 v1 access token is emptyps4_v1_token_expired- PS4 v1 access token is expiredps4_v1_token_exchange_failed- Problem exchanging code for token with PS4ps4_v1_id_token_request_failed- Problem requesting id token from PS4ps4_v1_id_token_not_valid- PS4 v1 id token is not validps4_v1_token_details_disabled- PS4 v1 token details are disabledps4_v1_token_details_request_failed- Problem requesting token details from PS4ps4_v3_disabled- PS4 v3 authentication is currently disabledps4_v3_token_details_disabled- PS4 v3 token details are disabledps4_v3_token_empty- PS4 v3 access token is emptyps4_v3_id_token_request_failed- Problem requesting id token from PS4ps4_v3_id_token_not_valid- PS4 v3 id token is not validps5_v3_disabled- PS5 v3 authentication is currently disabledps5_v3_token_details_disabled- PS5 v3 token details are disabledps5_v3_token_empty- PS5 v3 access token is emptyps5_v3_id_token_request_failed- Problem requesting id token from PS5ps5_v3_id_token_not_valid- PS5 v3 id token is not validpsn_environment_permission_denied- PSN Environment permission was denied. This usually means that the Client ID/Secret do not match. This error can also occur forsp-intorprod-qaif the environment is not whitelisted to access the PSN environment.refresh_disabled- Refresh authentication is currently disabledrefresh_token_empty- Refresh token is emptyrefresh_token_not_found- Refresh token was not found or has expiredrefresh_token_invalid_user- Refresh token refrences invalid userrefresh_token_client_id_mismatch- Client ID for new token request did not match original tokensteam_disabled- Steam authentication is currently disabledsteam_token_empty- Steam code (Ticket) is emptysteam_token_exchange_failed- Problem exchanging code (ticket) for token with Steamsteam_user_vacbanned- User is VAC bannedsteam_user_publisherbanned- User is publisher bannedtwitch_disabled- Twitch authentication is currently disabledtwitch_token_empty- Twitch access token is emptytwitch_token_invalid- Twitch access token is not validtwitch_keys_not_available- Twitch keys are not available. Please contact an administratortwitch_token_exchange_failed- Problem exchanging code for token with Twitchxbox_disabled- Xbox authentication is currently disabledxbox_xsts_token_empty- Xbox XSTS token is emptyxbox_xsts_token_invalid- Xbox XSTS token is not validxbox_xtoken_invalid- Xbox XToken is not validxbox_access_token_request_failed- Problem requesting access token from Xboxxbox_xsts_token_exchange_failed- Problem exchanging access token for XSTS token with Xboxxbox_xtoken_exchange_failed- Problem exchanging XSTS token for XToken with Xbox
object
auth_success
boolean
error_code
required
string
desc
required
string
422
Validation Error
object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string