OAuth 2

Attributes for configuring OAuth 2 authentication scheme for SCIM provisioning to an application.

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
authorization_url	string	URL used to generate the auth code used during token generation.
client_id	string	Client ID used to authenticate when generating a token for authenticating with the remote SCIM service.
client_secret	string	Secret used to authenticate when generating a token for authenticating with the remove SCIM service.
scheme	string	The authentication scheme to use when making SCIM requests to this application.
scopes	array	The authorization scopes to request when generating the token used to authenticate with the remove SCIM service.
token_url	string	URL used to generate the token used to authenticate with the remote SCIM service.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/access_scim_config_authentication_oauth2",
  "title": "OAuth 2",
  "description": "Attributes for configuring OAuth 2 authentication scheme for SCIM provisioning to an application.",
  "properties": {
    "authorization_url": {
      "description": "URL used to generate the auth code used during token generation.",
      "type": "string"
    },
    "client_id": {
      "description": "Client ID used to authenticate when generating a token for authenticating with the remote SCIM service.",
      "type": "string"
    },
    "client_secret": {
      "description": "Secret used to authenticate when generating a token for authenticating with the remove SCIM service.",
      "type": "string"
    },
    "scheme": {
      "description": "The authentication scheme to use when making SCIM requests to this application.",
      "enum": [
        "oauth2"
      ],
      "type": "string"
    },
    "scopes": {
      "description": "The authorization scopes to request when generating the token used to authenticate with the remove SCIM service.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "token_url": {
      "description": "URL used to generate the token used to authenticate with the remote SCIM service.",
      "type": "string"
    }
  },
  "required": [
    "scheme",
    "client_id",
    "client_secret",
    "authorization_url",
    "token_url"
  ],
  "type": "object"
}