com.authlete.common.types

Enum ClaimsScope

java.lang.Object

java.lang.Enum<ClaimsScope>

com.authlete.common.types.ClaimsScope

All Implemented Interfaces:

Serializable, Comparable<ClaimsScope>

public enum ClaimsScope
extends Enum<ClaimsScope>

Scopes which are used to request claims.

1. profile
2. email
3. address
4. phone

Author:

Takahiko Kawasaki

See Also:

OpenID Connect Core 1.0, 5.4. Requesting Claims using Scope Values

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADDRESS This scope ("address") requests the following claims.
EMAIL This scope ("email") requests the following claims.
PHONE This scope ("phone") requests the following claims.
PROFILE This scope ("profile") requests the following claims.

Method Summary

Modifier and Type	Method and Description
static ClaimsScope	getByName(String name) Get a ClaimsScope instance by a name.
SortedSet<String>	getClaims() Get the list of claim names which are requested by this scope.
String	getName() Get the scope name in lower-case letters.
static ClaimsScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClaimsScope[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PROFILE

public static final ClaimsScope PROFILE

This scope ("profile") requests the following claims.

1. name
2. family_name
3. given_name
4. middle_name
5. nickname
6. preferred_username
7. profile
8. picture
9. website
10. gender
11. birthdate
12. zoneinfo
13. locale
14. updated_at

EMAIL

public static final ClaimsScope EMAIL

This scope ("email") requests the following claims.

1. email
2. email_verified

ADDRESS

public static final ClaimsScope ADDRESS

This scope ("address") requests the following claims.

1. address

PHONE

public static final ClaimsScope PHONE

This scope ("phone") requests the following claims.

1. phone_number
2. phone_number_verified

Method Detail

values

public static ClaimsScope[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClaimsScope c : ClaimsScope.values())
    System.out.println(c);

Returns:

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

valueOf

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

getName

public String getName()

Get the scope name in lower-case letters.

Returns:

The scope name.

getClaims

public SortedSet<String> getClaims()

Get the list of claim names which are requested by this scope.

Returns:

The list of claim names.

getByName

public static ClaimsScope getByName(String name)

Get a ClaimsScope instance by a name.

Parameters:

name - A scope name such as "profile".

Returns:

A ClaimsScope instance, or null when no instance has the specified name.