org.cyclos.model.access.oidcclients

Enum Scope

java.lang.Object

java.lang.Enum<Scope>

org.cyclos.model.access.oidcclients.Scope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Scope>, HasMessageKey

public enum Scope
extends java.lang.Enum<Scope>
implements HasMessageKey

Supported OAuth 2 / OpenID Connect scopes

Author:

luis

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCOUNT_HISTORY Get the full account history.
ACCOUNT_STATUS Get the current account status.
ADDRESS Standard address scope, which gives access to the user's physical address.
EMAIL Standard email scope, which gives access to the user's e-mail address.
OFFLINE_ACCESS Standard offline access scope, which enables refresh tokens.
OPENID Standard openid scope, which enables the OpenID Connect features.
PAYMENT Perform payments.
PHONE Standard phone scope, which gives access to the user's phone number.
PROFILE Standard profile scope, which gives access to claims such as full name, login name, picture URL, custom fields and locale.
PROFILE_READ Read the full user profile.
PROFILE_WRITE Modify the full user profile.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<java.lang.String>	NAMES

Method Summary

Modifier and Type	Method and Description
boolean	dependsOnOpenid() Returns whether this scope requires the openid scope in order to be enabled
MessageKey	getMessageKey()
java.util.List<java.lang.String>	getParameters()
boolean	isAllowAdmins()
static Scope	of(java.lang.String value) Returns a scope by value, or null if not found
static java.util.Map<Scope,java.util.Map<java.lang.String,java.lang.String>>	parse(java.lang.String scope) Parses each scope together with its parameters
java.lang.String	toString()
static Scope	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Scope[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OPENID

public static final Scope OPENID

Standard openid scope, which enables the OpenID Connect features. When not requested, will be a plain OAuth2 authorization.

PROFILE

public static final Scope PROFILE

Standard profile scope, which gives access to claims such as full name, login name, picture URL, custom fields and locale.

EMAIL

public static final Scope EMAIL

Standard email scope, which gives access to the user's e-mail address.

PHONE

public static final Scope PHONE

Standard phone scope, which gives access to the user's phone number.

ADDRESS

public static final Scope ADDRESS

Standard address scope, which gives access to the user's physical address.

OFFLINE_ACCESS

public static final Scope OFFLINE_ACCESS

Standard offline access scope, which enables refresh tokens.

ACCOUNT_STATUS

public static final Scope ACCOUNT_STATUS

Get the current account status. Is never granted to administrators. Parameters:

• type: Restrict to a specific account type

ACCOUNT_HISTORY

public static final Scope ACCOUNT_HISTORY

Get the full account history. Is never granted to administrators. Parameters:

• type: Restrict to a specific account type

PAYMENT

public static final Scope PAYMENT

Perform payments. Is never granted to administrators. Parameters:

• to: Payments to a specific user
• amount: Payments with a specific amount
• currency: Payments with a specific currency. When an amount is specified, this must also be, unless the authenticated user have accounts in a single currency.

PROFILE_READ

public static final Scope PROFILE_READ

Read the full user profile. Is never granted to administrators.

PROFILE_WRITE

public static final Scope PROFILE_WRITE

Modify the full user profile. Is never granted to administrators.

Field Detail

NAMES

public static java.util.List<java.lang.String> NAMES

Method Detail

values

public static Scope[] 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 (Scope c : Scope.values())
    System.out.println(c);

Returns:

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

valueOf

public static Scope valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

of

public static Scope of(java.lang.String value)

Returns a scope by value, or null if not found

parse

public static java.util.Map<Scope,java.util.Map<java.lang.String,java.lang.String>> parse(java.lang.String scope)

Parses each scope together with its parameters

Throws:

java.lang.IllegalArgumentException - If any scope name isn't recognized, of if a scope has an unrecognized parameter

dependsOnOpenid

public boolean dependsOnOpenid()

Returns whether this scope requires the openid scope in order to be enabled

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey

getParameters

public java.util.List<java.lang.String> getParameters()

isAllowAdmins

public boolean isAllowAdmins()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Scope>