Authorization Endpoint

The Authorization Endpoint is the URL that the user’s browser visits to initiate the OAuth flow. It is used to request user authorization and produce an authorization code.

Endpoint: GET /api/oauth2

Purpose: Initiate an OAuth2 authorization code request (user login & consent).

Query Parameters:

• client_id (string, Required)

  • Your application’s client identifier. This value is provided when you register your app with AIRisk. It tells the authorization server which application is making the request.

• redirect_uri (string, Required)

  • The URL in your application where users will be sent after authorization. This must match one of the allowed redirect URIs you configured for your client. After the user approves or denies the request, AIRisk will redirect their browser to this URL with additional parameters (code or error).

• state (string, Optional)

  • A string locally generated and stored to use to prevent CSRF attacks. The value of this parameter must be stored and compared with the state parameter value existing alongside code in the response once having been redirected to the passed redirect_uri. The stored value must match the value retrieved from the response parameters. See this official oauth2 documentation for more information on this convention.

• userid (string, Optional)

  • An identifier for the user on whose behalf the authorization is being requested. Include this if you want a user-specific token. When provided, the authorization process will associate the resulting code with the specified user. If omitted, the authorization is not tied to a specific user and will result in a generic token (suitable for application-level access).