Sign in
Auth Settings

Create Identity Provider

Creates a new identity provider. This operation allows the creation of a new identity provider for authentication purposes.

post/v3/identity-providers

Request body

type'oidc' | 'saml'

Specifies the type of identity provider.

enabledboolean

Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC.

login_pathstring

The path used for initiating login requests with the identity provider.

Example request

{
  "type": "oidc",
  "enabled": true,
  "login_path": "myapp",
  "config": {
    "issuer_url": "https://konghq.okta.com/oauth2/default",
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "claim_mappings": {
      "name": "name",
      "email": "email",
      "groups": "groups"
    }
  }
}

Response

An identity provider configuration. This response represents the configuration of a specific identity provider, which can be either OIDC or SAML.

idstring uuid

Contains a unique identifier used for this resource.

type'oidc' | 'saml'

Specifies the type of identity provider.

enabledboolean

Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC.

login_pathstring

The path used for initiating login requests with the identity provider.

created_atstring date-time

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "type": "oidc",
  "enabled": true,
  "login_path": "myapp",
  "config": {
    "issuer_url": "https://konghq.okta.com/oauth2/default",
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "claim_mappings": {
      "name": "name",
      "email": "email",
      "groups": "groups"
    }
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

Changed in 8 of the 75 revisions of this API.12328

  • ccc33535acb52See the full diff
    • ▲

      the config/oneOf[subschema #2: SAML Identity Provider Config]/callback_url response's property type/format changed from string/path to string/uri for status 201

      response-property-type-changed

    • ▲

      the config/oneOf[subschema #2: SAML Identity Provider Config]/sp_metadata_url response's property type/format changed from string/path to string/uri for status 201

      response-property-type-changed

  • 8715e5b7ad9612See the full diff
    • ▲

      removed ConfigureOIDCIdentityProviderConfig from the config request property oneOf list

      request-property-one-of-removed

    • ○

      added OIDCIdentityProviderConfig to the config request property oneOf list

      request-property-one-of-added

    • ○

      added the optional write-only property config/oneOf[subschema #1: OIDC Identity Provider Config]/client_secret to the response with the 201 status

      response-optional-write-only-property-added

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

  • 8ab3ec3ed3011See the full diff
    • ●

      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

  • 3c0154b2053a56See 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 email request property default value email was added

      request-property-default-value-added

    • ○

      the groups request property default value groups was added

      request-property-default-value-added

    • ○

      the name request property default value name was added

      request-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      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

  • 6333a0d3b0956See the full diff
    • ○

      the email request property default value email was removed

      request-property-default-value-removed

    • ○

      the groups request property default value groups was removed

      request-property-default-value-removed

    • ○

      the name request property default value name was removed

      request-property-default-value-removed

    • ○

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

      response-property-default-value-removed

    • ○

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

      response-property-default-value-removed

    • ○

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

      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

  • 76b0fefddb0d6See the full diff
    • ○

      the email request property default value email was added

      request-property-default-value-added

    • ○

      the groups request property default value groups was added

      request-property-default-value-added

    • ○

      the name request property default value name was added

      request-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

  • 9a3d26a0008824See the full diff
    • ▲

      removed schemas-SAMLIdentityProviderConfig from the config request property oneOf list

      request-property-one-of-removed

    • ▲

      added OIDCIdentityProviderConfig SAMLIdentityProviderConfig to the config response property oneOf list for the response status 201

      response-property-one-of-added

    • ○

      added the new optional request property login_path

      new-optional-request-property

    • ○

      added SAMLIdentityProviderConfig to the config request property oneOf list

      request-property-one-of-added

    • ○

      added the optional property login_path to the response with the 201 status

      response-optional-property-added

    • ○

      removed schemas-OIDCIdentityProviderConfig schemas-SAMLIdentityProviderConfig from the config response property oneOf list for the response status 201

      response-property-one-of-removed

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

  • 0aead68de7b0224See the full diff
    • ▲

      removed SAMLIdentityProviderConfig from the config request property oneOf list

      request-property-one-of-removed

    • ▲

      added schemas-OIDCIdentityProviderConfig schemas-SAMLIdentityProviderConfig to the config response property oneOf list for the response status 201

      response-property-one-of-added

    • ●

      removed the request property login_path

      request-property-removed

    • ●

      removed the optional property login_path from the response with the 201 status

      response-optional-property-removed

    • ○

      added the new optional request property enabled

      new-optional-request-property

    • ○

      added schemas-SAMLIdentityProviderConfig to the config request property oneOf list

      request-property-one-of-added

    • ○

      added the non-success response with the status 409

      response-non-success-status-added

    • ○

      removed OIDCIdentityProviderConfig SAMLIdentityProviderConfig from the config response property oneOf list for the response status 201

      response-property-one-of-removed

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