Package com.okta.sdk.resource.model

Enum IdentityProviderType

java.lang.Object

java.lang.Enum<IdentityProviderType>

com.okta.sdk.resource.model.IdentityProviderType

All Implemented Interfaces:

Serializable, Comparable<IdentityProviderType>, java.lang.constant.Constable

public enum IdentityProviderType
extends Enum<IdentityProviderType>

The Identity Provider object's `type` property identifies the social or enterprise Identity Provider used for authentication. Each Identity Provider uses a specific protocol, therefore the `protocol` property must correspond with the IdP `type`. If the protocol is OAuth 2.0-based, the Protocol object's `scopes` property must also correspond with the scopes supported by the IdP `type`. For policy actions supported by each IdP type, see [IdP type policy actions](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/createIdentityProvider!path=policy&t=request). | Type | Description | Corresponding protocol | Corresponding protocol scopes | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | -------------------------------------------------------------------- | | `AMAZON` | [Amazon](https://developer.amazon.com/settings/console/registration?return_to=/)&nbsp;as the Identity Provider | OpenID Connect | `profile`, `profile:user_id` | | `APPLE` | [Apple](https://developer.apple.com/sign-in-with-apple/)&nbsp;as the Identity Provider | OpenID Connect | `names`, `email`, `openid` | | `DISCORD` | [Discord](https://discord.com/login)&nbsp;as the Identity Provider | OAuth 2.0 | `identify`, `email` | | `FACEBOOK` | [Facebook](https://developers.facebook.com)&nbsp;as the Identity Provider | OAuth 2.0 | `public_profile`, `email` | | `GITHUB` | [GitHub](https://github.com/join)&nbsp;as the Identity Provider | OAuth 2.0 | `user` | | `GITLAB` | [GitLab](https://gitlab.com/users/sign_in)&nbsp;as the Identity Provider | OpenID Connect | `openid`, `read_user`, `profile`, `email` | | `GOOGLE` | [Google](https://accounts.google.com/signup)&nbsp;as the Identity Provider | OpenID Connect | `openid`, `email`, `profile` | | `LINKEDIN` | [LinkedIn](https://developer.linkedin.com/)&nbsp;as the Identity Provider | OAuth 2.0 | `r_emailaddress`, `r_liteprofile` | | `LOGINGOV` | [Login.gov](https://developers.login.gov/)&nbsp;as the Identity Provider | OpenID Connect | `email`, `profile`, `profile:name` | | `LOGINGOV_SANDBOX` | [Login.gov's identity sandbox](https://developers.login.gov/testing/)&nbsp;as the Identity Provider | OpenID Connect | `email`, `profile`, `profile:name` | | `MICROSOFT` | [Microsoft Enterprise SSO](https://azure.microsoft.com/)&nbsp;as the Identity Provider | OpenID Connect | `openid`, `email`, `profile`, `https://graph.microsoft.com/User.Read` | | `OIDC` | IdP provider that supports [OpenID Connect](https://openid.net/specs/openid-connect-core-1_0.html) | OpenID Connect | `openid`, `email`, `profile` | | `PAYPAL` | [Paypal](https://www.paypal.com/signin)&nbsp;as the Identity Provider | OpenID Connect | `openid`, `email`, `profile` | | `PAYPAL_SANDBOX` | [Paypal Sandbox](https://developer.paypal.com/tools/sandbox/)&nbsp;as the Identity Provider | OpenID Connect | `openid`, `email`, `profile` | | `SALESFORCE` | [SalesForce](https://login.salesforce.com/)&nbsp;as the Identity Provider | OAuth 2.0 | `id`, `email`, `profile` | | `SAML2` | Enterprise IdP provider that supports the [SAML 2.0 Web Browser SSO Profile](https://docs.oasis-open.org/security/saml/v2.0/saml-profiles-2.0-os.pdf) | SAML 2.0 | | | `SPOTIFY` | [Spotify](https://developer.spotify.com/)&nbsp;as the Identity Provider | OpenID Connect | `user-read-email`, `user-read-private` | | `X509` | [Smart Card IdP](https://tools.ietf.org/html/rfc5280) | Mutual TLS | | | `XERO` | [Xero](https://www.xero.com/us/signup/api/)&nbsp;as the Identity Provider | OpenID Connect | `openid`, `profile`, `email` | | `YAHOO` | [Yahoo](https://login.yahoo.com/)&nbsp;as the Identity Provider | OpenID Connect | `openid`, `profile`, `email` | | `YAHOOJP` | [Yahoo Japan](https://login.yahoo.co.jp/config/login)&nbsp;as the Identity Provider | OpenID Connect | `openid`, `profile`, `email` |

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AMAZON
APPLE
DISCORD
FACEBOOK
GITHUB
GITLAB
GOOGLE
LINKEDIN
LOGINGOV
LOGINGOV_SANDBOX
MICROSOFT
OIDC
PAYPAL
PAYPAL_SANDBOX
SALESFORCE
SAML2
SPOTIFY
UNKNOWN_DEFAULT_OPEN_API
X509
XERO
YAHOO
YAHOOJP

Method Summary

Modifier and Type	Method	Description
static IdentityProviderType	fromValue(String value)
String	getValue()
String	toString()
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
static IdentityProviderType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IdentityProviderType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AMAZON

public static final IdentityProviderType AMAZON

APPLE

public static final IdentityProviderType APPLE

DISCORD

public static final IdentityProviderType DISCORD

FACEBOOK

public static final IdentityProviderType FACEBOOK

GITHUB

public static final IdentityProviderType GITHUB

GITLAB

public static final IdentityProviderType GITLAB

GOOGLE

public static final IdentityProviderType GOOGLE

LINKEDIN

public static final IdentityProviderType LINKEDIN

LOGINGOV

public static final IdentityProviderType LOGINGOV

LOGINGOV_SANDBOX

public static final IdentityProviderType LOGINGOV_SANDBOX

MICROSOFT

public static final IdentityProviderType MICROSOFT

OIDC

public static final IdentityProviderType OIDC

PAYPAL

public static final IdentityProviderType PAYPAL

PAYPAL_SANDBOX

public static final IdentityProviderType PAYPAL_SANDBOX

SALESFORCE

public static final IdentityProviderType SALESFORCE

SAML2

public static final IdentityProviderType SAML2

SPOTIFY

public static final IdentityProviderType SPOTIFY

X509

public static final IdentityProviderType X509

XERO

public static final IdentityProviderType XERO

YAHOO

public static final IdentityProviderType YAHOO

YAHOOJP

public static final IdentityProviderType YAHOOJP

UNKNOWN_DEFAULT_OPEN_API

public static final IdentityProviderType UNKNOWN_DEFAULT_OPEN_API

Method Details

values

public static IdentityProviderType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IdentityProviderType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

toString

public String toString()

Overrides:

toString in class Enum<IdentityProviderType>

fromValue

public static IdentityProviderType fromValue(String value)

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string