---
updatedAt: 2026-05-21T03:28:04.000Z
---

# Authorize the user to use OIDC.

Use this API to authorize a user to use OIDC. This endpoint requires valid login session cookies for the tenant.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "version": "1.0.0",
    "description": "OAuth and OIDC",
    "title": "OAuth and OIDC"
  },
  "servers": [
    {
      "url": "https://{tenanturl}",
      "variables": {
        "tenanturl": {
          "default": "{tenant_url}",
          "description": "URL of your IBM Security Verify tenant"
        }
      }
    }
  ],
  "tags": [
    {
      "name": "OpenID Connect"
    }
  ],
  "paths": {
    "/v1.0/endpoint/{opName}/authorize": {
      "get": {
        "tags": [
          "OpenID Connect"
        ],
        "summary": "Authorize the user to use OIDC.",
        "description": "Use this API to authorize a user to use OIDC. This endpoint requires valid login session cookies for the tenant.",
        "operationId": "handleAuthorizeGet",
        "parameters": [
          {
            "name": "opName",
            "in": "path",
            "description": "The OpenID Connect provider ID. The default provider ID is \"default\".",
            "required": true,
            "schema": {
              "type": "string",
              "default": "default",
              "enum": [
                "default"
              ]
            }
          },
          {
            "name": "client_id",
            "in": "query",
            "description": "The OIDC application's client ID.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "response_type",
            "in": "query",
            "description": "A space-delimited list of response types. Valid response types are: code, token, id_token.",
            "required": true,
            "schema": {
              "type": "string",
              "default": "code"
            }
          },
          {
            "name": "response_mode",
            "in": "query",
            "description": "The response mode. It defaults to query for the authorization_code grant type flow, and to fragment for the implicit grant type flow.",
            "schema": {
              "type": "string",
              "enum": [
                "query",
                "fragment",
                "form_post"
              ]
            }
          },
          {
            "name": "redirect_uri",
            "in": "query",
            "description": "The redirect URI.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "state",
            "in": "query",
            "description": "The state. An opaque value that is used to maintain the state between the request and the callback.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "nonce",
            "in": "query",
            "description": "Nonce. The string value that is used to associate a client session with an ID Token to mitigate replay attacks. This attribute is required when the response type includes id_token.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "prompt",
            "in": "query",
            "description": "Whether the user is prompted for reauthentication. When the value is \"login\", the user is reauthenticated. The reauthentication applies to default Cloud Directory logins only. When the value is \"none\", the user is not be prompted for authentication.",
            "schema": {
              "type": "string",
              "enum": [
                "none",
                "login"
              ]
            }
          },
          {
            "name": "max_age",
            "in": "query",
            "description": "Maximum authentication age. Specifies the allowable elapsed time, in seconds, since the last time the user was authenticated. This attribute applies to Cloud Directory login sessions only.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "code_challenge",
            "in": "query",
            "description": "Code challenge. Required if the OIDC application is configured to require proof key for code exchange (PKCE).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "code_challenge_method",
            "in": "query",
            "description": "Code challenge method for PKCE. Defaults to plain if not specified.",
            "schema": {
              "type": "string",
              "enum": [
                "plain",
                "S256"
              ]
            }
          },
          {
            "name": "scope",
            "in": "query",
            "description": "A space-delimited list of scopes that are associated with this authorization request.",
            "required": true,
            "schema": {
              "type": "string",
              "default": "openid"
            }
          },
          {
            "name": "claims",
            "in": "query",
            "description": "The JSON that contains the claims for id_token or userinfo endpoint.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "login_hint",
            "in": "query",
            "description": "Login hint. Value to use when prompting the user for login. Optional for OIDC request. This value could be the username as a string (e.g. john@ibm.com), or a JSON (e.g. {\"realm\":\"cloudIdentityRealm\",\"username\":\"john@ibm.com\"}). When using a JSON value, the realm represents the identity source realm.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Form post response.",
            "content": {}
          },
          "302": {
            "description": "Redirect response.",
            "headers": {
              "Location": {
                "description": "The redirection URI that has a query string or a fragment. For an error, it contains the error and error_description field. For success, it might return the authorization code, access_token, token_type, expires_in, scope, id_token, grant_id and state attributes.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {}
          },
          "400": {
            "description": "The error page that contains the error and error_description attributes.",
            "content": {}
          }
        },
        "x-category": "OAuth and OIDC",
        "x-publicAPI": "true"
      }
    }
  },
  "x-original-swagger-version": "2.0",
  "x-explorer-enabled": false
}
```