Package com.okta.sdk.resource.model

Enum OpenIdConnectApplicationConsentMethod

java.lang.Object

java.lang.Enum<OpenIdConnectApplicationConsentMethod>

com.okta.sdk.resource.model.OpenIdConnectApplicationConsentMethod

All Implemented Interfaces:

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

public enum OpenIdConnectApplicationConsentMethod
extends Enum<OpenIdConnectApplicationConsentMethod>

Indicates whether user consent is required or implicit. A consent dialog appears for the end user depending on the values of three elements: * [prompt](/openapi/okta-oauth/oauth/tag/OrgAS/#tag/OrgAS/operation/authorize!in=query&path=prompt&t=request): A query parameter that is used in requests to `/authorize` * `consent_method` (this property) * [consent](/openapi/okta-management/management/tag/AuthorizationServerScopes/#tag/AuthorizationServerScopes/operation/createOAuth2Scope!path=consent&t=request): A [Scope](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/AuthorizationServerScopes/) property that allows you to enable or disable user consent for an individual scope | `prompt` | `consent_method` | `consent` | Result | ---------- | ----------- | ---------- | ----------- | | CONSENT | TRUSTED or REQUIRED | REQUIRED | Prompted | | CONSENT | TRUSTED or REQUIRED | FLEXIBLE | Prompted | | CONSENT | TRUSTED | IMPLICIT | Not prompted | | NONE | TRUSTED | FLEXIBLE, IMPLICIT, or REQUIRED | Not prompted | | NONE | REQUIRED | FLEXIBLE or REQUIRED | Prompted | | NONE | REQUIRED | IMPLICIT | Not prompted | > **Notes:** > * If you request a scope that requires consent while using the `client_credentials` flow, an error is returned because the flow doesn't support user consent. > * If the `prompt` value is set to `NONE`, but the `consent_method` and the consent values are set to `REQUIRED`, then an error occurs. > * When a scope is requested during a Client Credentials grant flow and `consent` is set to `FLEXIBLE`, the scope is granted in the access token with no consent prompt. This occurs because there is no user involved in a two-legged OAuth 2.0 [Client Credentials](https://developer.okta.com/docs/guides/implement-grant-type/clientcreds/main/) grant flow.

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
REQUIRED
TRUSTED
UNKNOWN_DEFAULT_OPEN_API

Method Summary

Modifier and Type	Method	Description
static OpenIdConnectApplicationConsentMethod	fromValue(String value)
String	getValue()
String	toString()
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
static OpenIdConnectApplicationConsentMethod	valueOf(String name)	Returns the enum constant of this type with the specified name.
static OpenIdConnectApplicationConsentMethod[]	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

REQUIRED

public static final OpenIdConnectApplicationConsentMethod REQUIRED

TRUSTED

public static final OpenIdConnectApplicationConsentMethod TRUSTED

UNKNOWN_DEFAULT_OPEN_API

public static final OpenIdConnectApplicationConsentMethod UNKNOWN_DEFAULT_OPEN_API

Method Details

values

public static OpenIdConnectApplicationConsentMethod[] 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 OpenIdConnectApplicationConsentMethod 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<OpenIdConnectApplicationConsentMethod>

fromValue

public static OpenIdConnectApplicationConsentMethod 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