Auth0 · Schema

ClientAddonSAPAPI

SAP API addon configuration.

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
clientid	string	If activated in the OAuth 2.0 client configuration (transaction SOAUTH2) the SAML attribute client_id must be set and equal the client_id form parameter of the access token request.
usernameAttribute	string	Name of the property in the user object that maps to a SAP username. e.g. `email`.
tokenEndpointUrl	string	Your SAP OData server OAuth2 token endpoint URL.
scope	string	Requested scope for SAP APIs.
servicePassword	string	Service account password to use to authenticate API calls to the token endpoint.
nameIdentifierFormat	string	NameID element of the Subject which can be used to express the user's identity. Defaults to `urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ClientAddonSAPAPI",
  "title": "ClientAddonSAPAPI",
  "type": "object",
  "description": "SAP API addon configuration.",
  "additionalProperties": true,
  "properties": {
    "clientid": {
      "type": "string",
      "description": "If activated in the OAuth 2.0 client configuration (transaction SOAUTH2) the SAML attribute client_id must be set and equal the client_id form parameter of the access token request."
    },
    "usernameAttribute": {
      "type": "string",
      "description": "Name of the property in the user object that maps to a SAP username. e.g. `email`."
    },
    "tokenEndpointUrl": {
      "type": "string",
      "description": "Your SAP OData server OAuth2 token endpoint URL.",
      "format": "url"
    },
    "scope": {
      "type": "string",
      "description": "Requested scope for SAP APIs."
    },
    "servicePassword": {
      "type": "string",
      "description": "Service account password to use to authenticate API calls to the token endpoint."
    },
    "nameIdentifierFormat": {
      "type": "string",
      "description": "NameID element of the Subject which can be used to express the user's identity. Defaults to `urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified`."
    }
  }
}