Auth Settings

Get the IdP Configuration

Fetch the IdP configuration.

get/v3/identity-provider

Response

A get action response of the IdP configuration.

issuerstring uri
login_pathstring
client_idstring
scopesstring[]

Example response

{
  "issuer": "https://myidp.com/oauth2",
  "login_path": "myapp",
  "client_id": "YOUR_CLIENT_ID",
  "claim_mappings": {
    "name": "name",
    "email": "email",
    "groups": "custom-groups-claim"
  }
}

Changes

Changed in 4 of the 75 revisions of this API.9112

    • added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

  • 3c0154b2053a94See the full diff
    • the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400

      response-property-became-nullable

    • the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400

      response-property-became-nullable

    • the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400

      response-property-became-nullable

    • the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400

      response-property-became-nullable

    • the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400

      response-property-became-nullable

    • the response property claim_mappings became nullable for the status 200

      response-property-became-nullable

    • the response property client_id became nullable for the status 200

      response-property-became-nullable

    • the response property issuer became nullable for the status 200

      response-property-became-nullable

    • the response property login_path became nullable for the status 200

      response-property-became-nullable

    • the email response's property default value email was added for the status 200

      response-property-default-value-added

    • the groups response's property default value groups was added for the status 200

      response-property-default-value-added

    • the name response's property default value name was added for the status 200

      response-property-default-value-added

    • the scopes response's property default value email openid profile was added for the status 200

      response-property-default-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the email response's property default value email was removed for the status 200

      response-property-default-value-removed

    • the groups response's property default value groups was removed for the status 200

      response-property-default-value-removed

    • the name response's property default value name was removed for the status 200

      response-property-default-value-removed

    • the scopes response's property default value email openid profile was removed for the status 200

      response-property-default-value-removed

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the email response's property default value email was added for the status 200

      response-property-default-value-added

    • the groups response's property default value groups was added for the status 200

      response-property-default-value-added

    • the name response's property default value name was added for the status 200

      response-property-default-value-added

    • the scopes response's property default value email openid profile was added for the status 200

      response-property-default-value-added