OpenID Connect Identity Provider APIs

1. Overview

This API has been available since 1.1.0

OpenID Connect identity providers connect to external OpenID Connect login systems. This type of login will optionally provide a Login with …​ button on FusionAuth’s login page. This button is customizable by using different properties of the identity provider.

Optionally, this identity provider can define one or more domains it is associated with. This is useful for allowing employees to log in with their corporate credentials. As long as the company has an identity solution that provides OpenID Connect, you can leverage this feature. This is referred to as a Domain Based Identity Provider. If you enable domains for an identity provider, the Login with …​ button will not be displayed. Instead, only the email form field will be displayed initially on the FusionAuth login page. Once the user types in their email address, FusionAuth will determine if the user is logging in locally or if they should be redirected to this identity provider. This is determined by extracting the domain from their email address and comparing it to the domains associated with the identity provider.

FusionAuth will also leverage the /userinfo API that is part of the OpenID Connect specification. This API provides user information that is stored in FusionAuth. Since FusionAuth is also an OpenID Connect provider, it translates most of the OpenID Connect claims over. Here are the OpenID Connect claims that FusionAuth stores from an external OpenID Connect identity provider and the User object fields they are stored in:

  • birthdatebirthDate

  • emailemail

  • family_namelastName

  • given_namefirstName

  • localepreferredLanguages

  • middle_namemiddleName

  • namefullName

  • phone_numbermobilePhone

  • pictureimageUrl

If the external OpenID Connect identity provider returns a refresh token, it will be stored in the UserRegistration object inside the tokens Map. This Map stores the tokens from the various identity providers so that you can use them in your application to call their APIs.

1.1. Operations

2. Create an OpenID Connect Identity Provider

2.1. Request

Create an OpenID Connect Identity Provider using a generated id

URI

POST /api/identity-provider

Create an OpenID Connect Identity Provider with the provided unique id

URI

POST /api/identity-provider/{identityProviderId}

Table 1. Request Parameters

identityProviderId [UUID] Optional defaults to secure random UUID

The Id to use for the new Identity Provider. If an id is not provided, a secure random UUID is generated.

Table 2. Request Body

identityProvider.applicationConfiguration [Map<UUID, Object>] Optional

The configuration for each Application that the identity provider is enabled for.

identityProvider.applicationConfiguration[applicationId].buttonImageURL [String] Optional

This is an optional Application specific override for the top level button image URL.

identityProvider.applicationConfiguration[applicationId].buttonText [String] Optional

This is an optional Application specific override for the top level button text.

identityProvider.applicationConfiguration[applicationId].oauth2.client_id [String] Optional

This is an optional Application specific override for the top level client id.

identityProvider.applicationConfiguration[applicationId].oauth2.client_secret [String] Optional

This is an optional Application specific override for the top level client secret.

identityProvider.applicationConfiguration[applicationId].createRegistration [boolean] Optional defaults to true

Determines if a UserRegistration is created for the User automatically or not. If a user doesn’t exist in FusionAuth and logs in through an identity provider, this boolean controls whether or not FusionAuth creates a registration for the User in the Application they are logging into.

identityProvider.applicationConfiguration[applicationId].enabled [boolean] Optional defaults to false

Determines if this identity provider is enabled for the Application specified by the applicationId key.

identityProvider.applicationConfiguration[applicationId].oauth2.scope [String] Optional

This is an optional Application specific override for for the top level scope.

identityProvider.buttonImageURL [String] Optional

The top-level button image (URL) to use on the FusionAuth login page for this Identity Provider.

identityProvider.buttonText [String] Required

The top-level button text to use on the FusionAuth login page for this Identity Provider.

identityProvider.enabled [Boolean] Optional defaults to false

Determines if this provider is enabled. If it is false then it will be disabled globally.

identityProvider.domains [List<String>] Optional

This is an optional list of domains that this OpenID Connect provider should be used for. This converts the FusionAuth login form to a domain-based login form. This type of form first asks the user for their email. FusionAuth then uses their email to determine if an OpenID Connect identity provider should be used. If an OpenID Connect provider should be used, the browser is redirected to the authorization endpoint of that identity provider. Otherwise, the password field is revealed on the form so that the user can login using FusionAuth.

identityProvider.name [String] Required

The name of this OpenID Connect identity provider. This is only used for display purposes.

identityProvider.oauth2.authorization_endpoint [String] Optional

The top-level authorization endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the authorization endpoint. If you provide an issuer then this field will be ignored.

identityProvider.oauth2.client_id [String] Required

The top-level client id for your Application.

identityProvider.oauth2.client_secret [String] Optional

The top-level client secret to use with the OpenID Connect identity provider.

identityProvider.oauth2.issuer [String] Optional

The top-level issuer URI for the OpenID Connect identity provider. If this is provided, the authorization endpoint, token endpoint and userinfo endpoint will all be resolved using the issuer URI plus /.well-known/openid-configuration.

identityProvider.oauth2.scope [String] Optional

The top-level scope that you are requesting from the OpenID Connect identity provider.

identityProvider.oauth2.token_endpoint [String] Optional

The top-level token endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the token endpoint. If you provide an issuer then this field will be ignored.

identityProvider.oauth2.userinfo_endpoint [String] Optional

The top-level userinfo endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the userinfo endpoint. If you provide an issuer then this field will be ignored.

identityProvider.type [String] Required

This field must be set to OpenIDConnect.

Example OpenID Connect Request JSON
{
  "identityProvider" : {
    "applicationConfiguration" : {
      "1c212e59-0d0e-6b1a-ad48-f4f92793be32" : {
        "createRegistration" : true,
        "enabled" : true
      }
    },
    "oauth2": {
      "authorization_endpoint": "https://acme.com/oauth2/authorization",
      "client_id" : "191c23dc-b772-4558-bd21-dc1cbf74ae21",
      "client_secret" : "SUsnoP0pWUYfXvWbSe5pvj8Di5nAxOvO",
      "scope" : "openid offline_access",
      "token_endpoint" : "https://acme.com/oauth2/token",
      "userinfo_endpoint" : "https://acme.com/oauth2/userinfo"
    },
    "buttonText" : "Login with OpenID Connect",
    "enabled" : true,
    "name" : "Super Awesome OpenID Connect Provider",
    "type" : "OpenIDConnect"
  }
}

2.2. Response

Table 3. Response Codes
Code Description

200

The request was successful. The response will contain a JSON body.

400

The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.

401

You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

500

There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

503

The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

Table 4. Response Body

identityProvider.applicationConfiguration [Map<UUID, Object>]

The configuration for each Application that the identity provider is enabled for.

identityProvider.applicationConfiguration[applicationId].buttonImageURL [String]

This is an optional Application specific override for the top level button image URL.

identityProvider.applicationConfiguration[applicationId].buttonText [String]

This is an optional Application specific override for the top level button text.

identityProvider.applicationConfiguration[applicationId].client_id [String]

This is an optional Application specific override for the top level client id.

identityProvider.applicationConfiguration[applicationId].client_secret [String]

This is an optional Application specific override for the top level client secret.

identityProvider.applicationConfiguration[applicationId].createRegistration [boolean]

Determines if a UserRegistration is created for the User automatically or not. If a user doesn’t exist in FusionAuth and logs in through an identity provider, this boolean controls whether or not FusionAuth creates a registration for the User in the Application they are logging into.

identityProvider.applicationConfiguration[applicationId].enabled [boolean]

Determines if this identity provider is enabled for the Application specified by the applicationId key.

identityProvider.applicationConfiguration[applicationId].scope [String]

This is an optional Application specific override for for the top level scope.

identityProvider.buttonImageURL [String]

The top-level button image (URL) to use on the FusionAuth login page for this Identity Provider.

identityProvider.buttonText [String]

The top-level button text to use on the FusionAuth login page for this Identity Provider.

identityProvider.enabled [Boolean]

Determines if this provider is enabled. If it is false then it will be disabled globally.

identityProvider.domains [List<String>]

This is an optional list of domains that this OpenID Connect provider should be used for. This converts the FusionAuth login form to a domain-based login form. This type of form first asks the user for their email. FusionAuth then uses their email to determine if an OpenID Connect identity provider should be used. If an OpenID Connect provider should be used, the browser is redirected to the authorization endpoint of that identity provider. Otherwise, the password field is revealed on the form so that the user can login using FusionAuth.

identityProvider.id [UUID]

The Id of the provider.

identityProvider.name [String]

The name of this OpenID Connect identity provider. This is only used for display purposes.

identityProvider.oauth2.authorization_endpoint [String]

The top-level authorization endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the authorization endpoint. If you provide an issuer then this field will be ignored.

identityProvider.oauth2.client_id [String]

The top-level client id for your Application.

identityProvider.oauth2.client_secret [String]

The top-level client secret to use with the OpenID Connect identity provider.

identityProvider.oauth2.issuer [String]

The top-level issuer URI for the OpenID Connect identity provider. If this is provided, the authorization endpoint, token endpoint and userinfo endpoint will all be resolved using the issuer URI plus /.well-known/openid-configuration.

identityProvider.oauth2.scope [String]

The top-level scope that you are requesting from the OpenID Connect identity provider.

identityProvider.oauth2.token_endpoint [String]

The top-level token endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the token endpoint. If you provide an issuer then this field will be ignored.

identityProvider.oauth2.userinfo_endpoint [String]

The top-level userinfo endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the userinfo endpoint. If you provide an issuer then this field will be ignored.

identityProvider.type [String]

This field must be set to OpenIDConnect.

Example OpenID Connect Response JSON
{
  "identityProvider" : {
    "applicationConfiguration" : {
      "1c212e59-0d0e-6b1a-ad48-f4f92793be32" : {
        "createRegistration" : true,
        "enabled" : true
      }
    },
    "oauth2": {
      "authorization_endpoint": "https://acme.com/oauth2/authorization",
      "client_id" : "191c23dc-b772-4558-bd21-dc1cbf74ae21",
      "client_secret" : "SUsnoP0pWUYfXvWbSe5pvj8Di5nAxOvO",
      "scope" : "openid offline_access",
      "token_endpoint" : "https://acme.com/oauth2/token",
      "userinfo_endpoint" : "https://acme.com/oauth2/userinfo"
    },
    "buttonText" : "Login with OpenID Connect",
    "enabled" : true,
    "id" : "19544aa2-d634-4859-b193-e57af82b5d12",
    "name" : "Super Awesome OpenID Connect Provider",
    "type" : "OpenIDConnect"
  }
}

3. Retrieve an OpenID Connect Identity Provider

3.1. Request

Retrieve an Identity Provider by Id

URI

GET /api/identity-provider/{identityProviderId}

Table 5. Request Parameters

identityProviderId [UUID] Required

The unique Id of the OpenID Connect Identity Provider to retrieve.

3.2. Response

Table 6. Response Codes
Code Description

200

The request was successful. The response will contain a JSON body.

400

The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.

401

You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

404

The object you requested doesn’t exist. The response will be empty.

500

There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

503

The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

Table 7. Response Body

identityProvider.applicationConfiguration [Map<UUID, Object>]

The configuration for each Application that the identity provider is enabled for.

identityProvider.applicationConfiguration[applicationId].buttonImageURL [String]

This is an optional Application specific override for the top level button image URL.

identityProvider.applicationConfiguration[applicationId].buttonText [String]

This is an optional Application specific override for the top level button text.

identityProvider.applicationConfiguration[applicationId].client_id [String]

This is an optional Application specific override for the top level client id.

identityProvider.applicationConfiguration[applicationId].client_secret [String]

This is an optional Application specific override for the top level client secret.

identityProvider.applicationConfiguration[applicationId].createRegistration [boolean]

Determines if a UserRegistration is created for the User automatically or not. If a user doesn’t exist in FusionAuth and logs in through an identity provider, this boolean controls whether or not FusionAuth creates a registration for the User in the Application they are logging into.

identityProvider.applicationConfiguration[applicationId].enabled [boolean]

Determines if this identity provider is enabled for the Application specified by the applicationId key.

identityProvider.applicationConfiguration[applicationId].scope [String]

This is an optional Application specific override for for the top level scope.

identityProvider.buttonImageURL [String]

The top-level button image (URL) to use on the FusionAuth login page for this Identity Provider.

identityProvider.buttonText [String]

The top-level button text to use on the FusionAuth login page for this Identity Provider.

identityProvider.enabled [Boolean]

Determines if this provider is enabled. If it is false then it will be disabled globally.

identityProvider.domains [List<String>]

This is an optional list of domains that this OpenID Connect provider should be used for. This converts the FusionAuth login form to a domain-based login form. This type of form first asks the user for their email. FusionAuth then uses their email to determine if an OpenID Connect identity provider should be used. If an OpenID Connect provider should be used, the browser is redirected to the authorization endpoint of that identity provider. Otherwise, the password field is revealed on the form so that the user can login using FusionAuth.

identityProvider.id [UUID]

The Id of the provider.

identityProvider.name [String]

The name of this OpenID Connect identity provider. This is only used for display purposes.

identityProvider.oauth2.authorization_endpoint [String]

The top-level authorization endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the authorization endpoint. If you provide an issuer then this field will be ignored.

identityProvider.oauth2.client_id [String]

The top-level client id for your Application.

identityProvider.oauth2.client_secret [String]

The top-level client secret to use with the OpenID Connect identity provider.

identityProvider.oauth2.issuer [String]

The top-level issuer URI for the OpenID Connect identity provider. If this is provided, the authorization endpoint, token endpoint and userinfo endpoint will all be resolved using the issuer URI plus /.well-known/openid-configuration.

identityProvider.oauth2.scope [String]

The top-level scope that you are requesting from the OpenID Connect identity provider.

identityProvider.oauth2.token_endpoint [String]

The top-level token endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the token endpoint. If you provide an issuer then this field will be ignored.

identityProvider.oauth2.userinfo_endpoint [String]

The top-level userinfo endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the userinfo endpoint. If you provide an issuer then this field will be ignored.

identityProvider.type [String]

This field must be set to OpenIDConnect.

Example OpenID Connect Response JSON
{
  "identityProvider" : {
    "applicationConfiguration" : {
      "1c212e59-0d0e-6b1a-ad48-f4f92793be32" : {
        "createRegistration" : true,
        "enabled" : true
      }
    },
    "oauth2": {
      "authorization_endpoint": "https://acme.com/oauth2/authorization",
      "client_id" : "191c23dc-b772-4558-bd21-dc1cbf74ae21",
      "client_secret" : "SUsnoP0pWUYfXvWbSe5pvj8Di5nAxOvO",
      "scope" : "openid offline_access",
      "token_endpoint" : "https://acme.com/oauth2/token",
      "userinfo_endpoint" : "https://acme.com/oauth2/userinfo"
    },
    "buttonText" : "Login with OpenID Connect",
    "enabled" : true,
    "id" : "19544aa2-d634-4859-b193-e57af82b5d12",
    "name" : "Super Awesome OpenID Connect Provider",
    "type" : "OpenIDConnect"
  }
}

4. Update an OpenID Connect Identity Provider

4.1. Request

Update an Identity Provider

URI

PUT /api/identity-provider/{identityProviderId}

Table 8. Request Parameters

identityProviderId [UUID] Required

The unique Id of the OpenID Connect Identity Provider to update.

Table 9. Request Body

identityProvider.applicationConfiguration [Map<UUID, Object>] Optional

The configuration for each Application that the identity provider is enabled for.

identityProvider.applicationConfiguration[applicationId].buttonImageURL [String] Optional

This is an optional Application specific override for the top level button image URL.

identityProvider.applicationConfiguration[applicationId].buttonText [String] Optional

This is an optional Application specific override for the top level button text.

identityProvider.applicationConfiguration[applicationId].oauth2.client_id [String] Optional

This is an optional Application specific override for the top level client id.

identityProvider.applicationConfiguration[applicationId].oauth2.client_secret [String] Optional

This is an optional Application specific override for the top level client secret.

identityProvider.applicationConfiguration[applicationId].createRegistration [boolean] Optional defaults to true

Determines if a UserRegistration is created for the User automatically or not. If a user doesn’t exist in FusionAuth and logs in through an identity provider, this boolean controls whether or not FusionAuth creates a registration for the User in the Application they are logging into.

identityProvider.applicationConfiguration[applicationId].enabled [boolean] Optional defaults to false

Determines if this identity provider is enabled for the Application specified by the applicationId key.

identityProvider.applicationConfiguration[applicationId].oauth2.scope [String] Optional

This is an optional Application specific override for for the top level scope.

identityProvider.buttonImageURL [String] Optional

The top-level button image (URL) to use on the FusionAuth login page for this Identity Provider.

identityProvider.buttonText [String] Required

The top-level button text to use on the FusionAuth login page for this Identity Provider.

identityProvider.enabled [Boolean] Optional defaults to false

Determines if this provider is enabled. If it is false then it will be disabled globally.

identityProvider.domains [List<String>] Optional

This is an optional list of domains that this OpenID Connect provider should be used for. This converts the FusionAuth login form to a domain-based login form. This type of form first asks the user for their email. FusionAuth then uses their email to determine if an OpenID Connect identity provider should be used. If an OpenID Connect provider should be used, the browser is redirected to the authorization endpoint of that identity provider. Otherwise, the password field is revealed on the form so that the user can login using FusionAuth.

identityProvider.name [String] Required

The name of this OpenID Connect identity provider. This is only used for display purposes.

identityProvider.oauth2.authorization_endpoint [String] Optional

The top-level authorization endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the authorization endpoint. If you provide an issuer then this field will be ignored.

identityProvider.oauth2.client_id [String] Required

The top-level client id for your Application.

identityProvider.oauth2.client_secret [String] Optional

The top-level client secret to use with the OpenID Connect identity provider.

identityProvider.oauth2.issuer [String] Optional

The top-level issuer URI for the OpenID Connect identity provider. If this is provided, the authorization endpoint, token endpoint and userinfo endpoint will all be resolved using the issuer URI plus /.well-known/openid-configuration.

identityProvider.oauth2.scope [String] Optional

The top-level scope that you are requesting from the OpenID Connect identity provider.

identityProvider.oauth2.token_endpoint [String] Optional

The top-level token endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the token endpoint. If you provide an issuer then this field will be ignored.

identityProvider.oauth2.userinfo_endpoint [String] Optional

The top-level userinfo endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the userinfo endpoint. If you provide an issuer then this field will be ignored.

identityProvider.type [String] Required

This field must be set to OpenIDConnect.

Example OpenID Connect Request JSON
{
  "identityProvider" : {
    "applicationConfiguration" : {
      "1c212e59-0d0e-6b1a-ad48-f4f92793be32" : {
        "createRegistration" : true,
        "enabled" : true
      }
    },
    "oauth2": {
      "authorization_endpoint": "https://acme.com/oauth2/authorization",
      "client_id" : "191c23dc-b772-4558-bd21-dc1cbf74ae21",
      "client_secret" : "SUsnoP0pWUYfXvWbSe5pvj8Di5nAxOvO",
      "scope" : "openid offline_access",
      "token_endpoint" : "https://acme.com/oauth2/token",
      "userinfo_endpoint" : "https://acme.com/oauth2/userinfo"
    },
    "buttonText" : "Login with OpenID Connect",
    "enabled" : true,
    "name" : "Super Awesome OpenID Connect Provider",
    "type" : "OpenIDConnect"
  }
}

4.2. Response

The response for this API contains the OpenID Connect Identity Provider that was updated.

Table 10. Response Codes
Code Description

200

The request was successful. The response will contain a JSON body.

400

The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.

401

You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

404

The object you are trying to updated doesn’t exist. The response will be empty.

500

There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

503

The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

Table 11. Response Body

identityProvider.applicationConfiguration [Map<UUID, Object>]

The configuration for each Application that the identity provider is enabled for.

identityProvider.applicationConfiguration[applicationId].buttonImageURL [String]

This is an optional Application specific override for the top level button image URL.

identityProvider.applicationConfiguration[applicationId].buttonText [String]

This is an optional Application specific override for the top level button text.

identityProvider.applicationConfiguration[applicationId].client_id [String]

This is an optional Application specific override for the top level client id.

identityProvider.applicationConfiguration[applicationId].client_secret [String]

This is an optional Application specific override for the top level client secret.

identityProvider.applicationConfiguration[applicationId].createRegistration [boolean]

Determines if a UserRegistration is created for the User automatically or not. If a user doesn’t exist in FusionAuth and logs in through an identity provider, this boolean controls whether or not FusionAuth creates a registration for the User in the Application they are logging into.

identityProvider.applicationConfiguration[applicationId].enabled [boolean]

Determines if this identity provider is enabled for the Application specified by the applicationId key.

identityProvider.applicationConfiguration[applicationId].scope [String]

This is an optional Application specific override for for the top level scope.

identityProvider.buttonImageURL [String]

The top-level button image (URL) to use on the FusionAuth login page for this Identity Provider.

identityProvider.buttonText [String]

The top-level button text to use on the FusionAuth login page for this Identity Provider.

identityProvider.enabled [Boolean]

Determines if this provider is enabled. If it is false then it will be disabled globally.

identityProvider.domains [List<String>]

This is an optional list of domains that this OpenID Connect provider should be used for. This converts the FusionAuth login form to a domain-based login form. This type of form first asks the user for their email. FusionAuth then uses their email to determine if an OpenID Connect identity provider should be used. If an OpenID Connect provider should be used, the browser is redirected to the authorization endpoint of that identity provider. Otherwise, the password field is revealed on the form so that the user can login using FusionAuth.

identityProvider.id [UUID]

The Id of the provider.

identityProvider.name [String]

The name of this OpenID Connect identity provider. This is only used for display purposes.

identityProvider.oauth2.authorization_endpoint [String]

The top-level authorization endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the authorization endpoint. If you provide an issuer then this field will be ignored.

identityProvider.oauth2.client_id [String]

The top-level client id for your Application.

identityProvider.oauth2.client_secret [String]

The top-level client secret to use with the OpenID Connect identity provider.

identityProvider.oauth2.issuer [String]

The top-level issuer URI for the OpenID Connect identity provider. If this is provided, the authorization endpoint, token endpoint and userinfo endpoint will all be resolved using the issuer URI plus /.well-known/openid-configuration.

identityProvider.oauth2.scope [String]

The top-level scope that you are requesting from the OpenID Connect identity provider.

identityProvider.oauth2.token_endpoint [String]

The top-level token endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the token endpoint. If you provide an issuer then this field will be ignored.

identityProvider.oauth2.userinfo_endpoint [String]

The top-level userinfo endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the userinfo endpoint. If you provide an issuer then this field will be ignored.

identityProvider.type [String]

This field must be set to OpenIDConnect.

Example OpenID Connect Response JSON
{
  "identityProvider" : {
    "applicationConfiguration" : {
      "1c212e59-0d0e-6b1a-ad48-f4f92793be32" : {
        "createRegistration" : true,
        "enabled" : true
      }
    },
    "oauth2": {
      "authorization_endpoint": "https://acme.com/oauth2/authorization",
      "client_id" : "191c23dc-b772-4558-bd21-dc1cbf74ae21",
      "client_secret" : "SUsnoP0pWUYfXvWbSe5pvj8Di5nAxOvO",
      "scope" : "openid offline_access",
      "token_endpoint" : "https://acme.com/oauth2/token",
      "userinfo_endpoint" : "https://acme.com/oauth2/userinfo"
    },
    "buttonText" : "Login with OpenID Connect",
    "enabled" : true,
    "id" : "19544aa2-d634-4859-b193-e57af82b5d12",
    "name" : "Super Awesome OpenID Connect Provider",
    "type" : "OpenIDConnect"
  }
}

5. Delete an OpenID Connect Identity Provider

5.1. Request

Delete an OpenId Connect Identity Provider by Id

URI

DELETE /api/identity-provider/{identityProviderId}

Table 12. Request Parameters

identityProviderId [UUID] Required

The unique Id of the OpenId Connect Identity Provider to delete.

5.2. Response

This API does not return a JSON response body.

Table 13. Response Codes
Code Description

200

The request was successful. The response will be empty.

400

The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.

401

You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

404

The object you are trying to delete doesn’t exist. The response will be empty.

500

There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

503

The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

6. Complete an OpenID Connect Login

This API allows you to complete an OpenID Connect login after authenticating a user using the OpenID Connect Authorized endpoint. If you are using the FusionAuth login UI with the OpenID Connect button you will not utilize this API directly.

This API is intended to be used if you want to build your own login page and you have added an OpenID Connect login button to your own login page and you then need to complete the login workflow.

For example, if you built your own login page, you could add a Login with Piped Piper button to utilize a third party OpenID Connect identity provider. When you complete the OpenID Connect authorization step you will have been returned an authorization code from the OpenID Connect provider. Using this API you can pass the authorization token returned from the OpenID Connect provider to FusionAuth and we will complete the login workflow and reconcile the user to FusionAuth.

6.1. Request

Complete OpenID Connect Login

URI

POST /api/identity-provider/login

Table 14. Request Headers

X-Forwarded-For [String] Optional

The IP address of a client requesting authentication. If the IP address is provided it will be stored for login history of the user. It is generally preferred to specify the IP address in the request body. If it is not provided in the request body this header value will be used if available, the request body value will take precedence.

Table 15. Request Body

applicationId [UUID] Required

The Id of the Application the user is to be logged into. This application must have OpenID Connect login enabled for this request to succeed.

device [String] Optional

The unique device identifier for this request.

Use this parameter to cause a refresh token cookie will be written to the client on the response named refresh_token and it will also be provided in the response body. This value should be unique to the device and the same device id should be sent on subsequent requests for the same device.

identityProviderId [UUID] Required

The unique Id of the identity provider to process this login request.

ipAddress [String] Optional

The IP address of the end-user that is logging into FusionAuth. If this value is omitted FusionAuth will attempt to obtain the IP address of the client, the value will be that of the X-Forwarded-For header if provided or the last proxy that sent the request. The IP address will be stored in the User login history.

data.code [String] Required

The authorization code, this is the code parameter that was returned on the Authorization redirect URI. This code will be sent to the Token endpoint as the code parameter.

data.redirect_uri [String] Required

The redirect URI that was provided to the OpenID Connect Authorization endpoint. This value will be sent to the Token endpoint as the redirect_uri parameter.

metaData.device.description [String] Optional

A human readable description of the device represented by the device parameter.

metaData.device.lastAccessedAddress [String] Optional

The IP address of this login request.

metaData.device.name [String] Optional

A human readable name of the device represented by the device parameter.

metaData.device.type [String] Optional

The type of device represented by the device parameter. The following types may be specified:

  • BROWSER

  • DESKTOP

  • LAPTOP

  • MOBILE

  • OTHER

  • SERVER

  • TABLET

  • TV

  • UNKNOWN

noJWT [Boolean] Optional defaults to false

When this value is set to true a JWT will not be issued as part of this request. The response body will not contain the token field, and the access_token and refresh_token cookies will not be written to the HTTP response.

This optional parameter may be helpful when performing high volume authentication requests and the JWT is not being utilized, in this scenario removing the additional latency required to issue and sign the JWT may have a measurable cumulative effect on performance.

Example Request JSON
{
  "applicationId": "10000000-0000-0002-0000-000000000001",
  "data": {
    "code": "1179659262-VUvqmPjPcGC9BxwHdVxMGs0ka5Gmz91G0svPp2Z",
    "redirect_uri": "https://login.piedpiper.com/oauth2/callback"
  },
  "identityProviderId": "19544aa2-d634-4859-b193-e57af82b5d12",
  "ipAddress": "192.168.1.42"
}

6.2. Response

The response for this API contains the User object.

Table 16. Response Codes
Code Description

200

The authentication was successful. The response will contain the User object that was authenticated.

202

The user was authenticated successfully. The user is not registered for the application specified by applicationId on the request. The response will contain the User object that was authenticated.

203

The user was authenticated successfully. The user is required to change their password, the response will contain the changePasswordId to be used on the Change Password API.

Example Response JSON
{
  "changePasswordId": "XOgai4Ro68xfGiex0ngXiJ2bbhduM4Pm7h3lvF0xibQ"
}

212

The user’s email address has not yet been verified. The response will contain the User object that was authenticated.

242

The user was authenticated successfully. The user has two factor authentication enabled, the response will contain the twoFactorId to be used on the [Complete Two Factor Authentication].

Example Response JSON
{
  "twoFactorId": "YkQY5Gsyo4RlfmDciBGRmvfj3RmatUqrbjoIZ19fmw4"
}

400

The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.

404

The user was not found or the password was incorrect. The response will be empty.

409

The user is currently in an action that has prevented login. The response will contain the actions that prevented login.

Example Response JSON
{
  "actions": [
    {
      "actionId": "00000000-0000-0000-0000-000000000042",
      "actionerUserId": "00000000-0000-0001-0000-000000000000",
      "expiry": 1571786483322,
      "localizedName": "Prevent Login Action",
      "localizedReason": "Hard Lock",
      "name": "Prevent Login Action",
      "reason": "Hard Lock",
      "reasonCode": "hard_lock"
    }
  ]
}

410

The user has expired. The response will be empty.

500

There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

503

The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

Table 17. Response Body

refreshToken [String]

The refresh token that can be used to obtain a new access token once the provide one has expired.

token [String]

The access token, this string is an encoded JSON Web Token (JWT).

user.active [Boolean]

True if the User is active. False if the User has been deactivated. Deactivated Users will not be able to login.

user.birthDate [String]

The User’s birthdate formatted as YYYY-MM-DD

user.cleanSpeakId [UUID]

This Id is used by FusionAuth when the User’s username is sent to CleanSpeak to be moderated (filtered and potentially sent to the approval queue). It is the content Id of the username inside CleanSpeak.

user.data [Object]

An object that can hold any information about the User that should be persisted.

user.email [String]

The User’s email address.

user.expiry [Long]

The expiration instant of the User’s account. An expired user is not permitted to login.

user.firstName [String]

The first name of the User.

user.fullName [String]

The User’s full name (as a separate field that is not calculated from firstName and lastName)

user.id [UUID]

The User’s unique Id.

user.imageUrl [String]

The URL that points to an image file that is the User’s profile image.

user.insertInstant [Long]

The instant when user was created.

user.lastLoginInstant [Long]

The instant when the User logged in last.

user.lastName [String]

The User’s last name.

user.middleName [String]

The User’s middle name.

user.mobilePhone [String]

The User’s mobile phone number. This is useful is you will be sending push notifications or SMS messages to the User.

user.passwordChangeRequired [Boolean]

Indicates that the User’s password needs to be changed during their next login attempt.

user.passwordLastUpdateInstant [Long]

The instant that the User last changed their password.

user.preferredLanguages [Array<String>]

An array of locale strings that give, in order, the User’s preferred languages. These are important for email templates and other localizable text. See Locales.

user.registrations [Array]

The list of registrations for the User.

user.registrations[x].applicationId [UUID]

The Id of the Application that this registration is for.

user.registrations[x].cleanSpeakId [UUID]

This Id is used by FusionAuth when the User’s username for this registration is sent to CleanSpeak to be moderated (filtered and potentially sent to the approval queue). It is the content Id of the username inside CleanSpeak.

user.registrations[x].data [Object]

An object that can hold any information about the User for this registration that should be persisted.

user.registrations[x].id [UUID]

The Id of this registration.

user.registrations[x].insertInstant [Long]

The instant that this registration was created.

user.registrations[x].lastLoginInstant [Long]

The instant that the User last logged into the Application for this registration.

user.registrations[x].preferredLanguages [Array<String>]

An array of locale strings that give, in order, the User’s preferred languages for this registration. These are important for email templates and other localizable text.

user.registrations[x].roles [Array<String>]

The list of roles that the User has for this registration.

user.registrations[x].timezone [String]

The User’s preferred timezone for this registration.

user.registrations[x].tokens [Map<String,String>] Available Since 1.1.0

A map that contains tokens returned from identity providers.

For example, if this user has authenticated using the Facebook Identity Provider, the Facebook access token will be available in this map, keyed by name Facebook. For an OpenID Connect Identity provider, or other generic providers, if a token is stored it will be keyed by the Identity Provider unique Id.

user.registrations[x].username [String]

The username of the User for this registration only.

user.registrations[x].usernameStatus [String]

The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are:

  • ACTIVE - the username is active

  • PENDING - the username is pending approval/moderation

  • REJECTED - the username was rejected during moderation

If a username has been rejected, it is still possible to allow the User to update it and have the new one moderated again.

user.timezone [String]

The User’s preferred timezone.

users.twoFactorDelivery [String]

The User’s preferred delivery for verification codes during a two factor login request.

The possible values are:

  • None

  • TextMessage

user.twoFactorEnabled [Boolean]

Determines if the User has two factor authentication enabled for their account or not.

user.username [String]

The username of the User.

user.usernameStatus [String]

The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are:

  • ACTIVE - the username is active

  • PENDING - the username is pending approval/moderation

  • REJECTED - the username was rejected during moderation

If a username has been rejected, it is still possible to allow the User to update it and have the new one moderated again.

user.verified [Boolean]

Whether or not the User’s email has been verified.

Example Response JSON
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0ODUxNDA5ODQsImlhdCI6MTQ4NTEzNzM4NCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiIyOWFjMGMxOC0wYjRhLTQyY2YtODJmYy0wM2Q1NzAzMThhMWQiLCJhcHBsaWNhdGlvbklkIjoiNzkxMDM3MzQtOTdhYi00ZDFhLWFmMzctZTAwNmQwNWQyOTUyIiwicm9sZXMiOltdfQ.Mp0Pcwsz5VECK11Kf2ZZNF_SMKu5CgBeLN9ZOP04kZo",
  "user": {
    "active": true,
    "birthDate": "1976-05-30",
    "data": {
      "displayName": "Johnny Boy",
      "favoriteColors": [
        "Red",
        "Blue"
      ]
    },
    "email": "example@fusionauth.io",
    "expiry": 1571786483322,
    "firstName": "John",
    "fullName": "John Doe",
    "id": "00000000-0000-0001-0000-000000000000",
    "imageUrl": "http://65.media.tumblr.com/tumblr_l7dbl0MHbU1qz50x3o1_500.png",
    "lastLoginInstant": 1471786483322,
    "lastName": "Doe",
    "middleName": "William",
    "mobilePhone": "303-555-1234",
    "passwordChangeRequired": false,
    "passwordLastUpdateInstant": 1471786483322,
    "preferredLanguages": [
      "en",
      "fr"
    ],
    "registrations": [
      {
        "applicationId": "10000000-0000-0002-0000-000000000001",
        "data": {
          "displayName": "Johnny",
          "favoriteSports": [
            "Football",
            "Basketball"
          ]
        },
        "id": "00000000-0000-0002-0000-000000000000",
        "insertInstant": 1446064706250,
        "lastLoginInstant": 1456064601291,
        "preferredLanguages": [
          "en",
          "fr"
        ],
        "roles": [
          "user",
          "community_helper"
        ],
        "tokens": {
          "Facebook": "nQbbBIzDhMXXfa7iDUoonz5zS",
          "19544aa2-d634-4859-b193-e57af82b5d12": "eu1SsrjsiDf3h3LryUjxHIKTS0yyrbiPcsKF3HDp"
        },
        "username": "johnny123",
        "usernameStatus": "ACTIVE"
      }
    ],
    "timezone": "America/Denver",
    "twoFactorEnabled": false,
    "usernameStatus": "ACTIVE",
    "username": "johnny123",
    "verified": true
  }
}
Table 18. Response Cookies

access_token [String]

The access token, this string is an encoded JSON Web Token (JWT). This cookie is written in the response as an HTTP Only session cookie.

refresh_token [String]

The refresh token. This cookie is written in the response as an HTTP only persistent cookie. The cookie expiration is configured in the JWT configuration for the application or the global JWT configuration.