Users

Reject Authorization

Changed on

Reject a game hub login attempt that cannot proceed and return a URL to show the error.

The waiting Game Hub page, identified by the nonce from the authorization deep link, cancels its waiter and shows the error to the player, so the login flow ends instead of hanging.

Opening the returned URL is optional: the game client may open it to show the error itself, and the flow still resolves if it never does.

post/v1/users/authorize/reject

Request

  • Base URL
    https://api.aghanim.com/s2s
  • URL
    https://api.aghanim.com/s2s/v1/users/authorize/reject
  • Auth
    HTTP bearer

Request body

noncestring required

The nonce from the authorization deep link, used to notify the waiting hub session.

reason'not_eligible' | 'banned' | 'rejected' required

Reason a game hub login cannot proceed.

  • not_eligible: the player has not unlocked hub access yet
  • banned: the player's game account is suspended
  • rejected: the game server declined the login for any other reason

Response

Successful Response

error_urlstring uri required

The game hub URL that shows the error to the player. Opening it is purely optional and the login is already rejected either way.

Changes

  • 0ef278347679Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • b06feb9e1630Revision changes
    • breaking

      the request property became required