com.nimbusds.openid.connect.provider.spi.claims.ClaimsSupport Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of c2id-server-sdk Show documentation

SDK for Connect2id Server extensions, such as OpenID Connect claims sources and OAuth 2.0 grant handlers

There is a newer version: 5.8

package com.nimbusds.openid.connect.provider.spi.claims;


import java.util.Set;

import net.jcip.annotations.ThreadSafe;


/**
 * Interface for querying OpenID Connect claims support. Implementations must
 * be thread-safe.
 */
@ThreadSafe
public interface ClaimsSupport {


	/**
	 * Returns the names of the supported OpenID Connect claims.
	 *
	 * Wildcard character use:
	 *
	 * 

	 *     Support for a pattern of claims can be indicated with the
	 *         '*' wildcard character, e.g. "https://idp.example.com/*" for
	 *         a set of claims having a common URI prefix.
	 *     
Returning a single claim set to "*" indicates support for
	 *         all requested claims (for a catch-all claim source).
	 * 
	 *
	 * Example:
	 *
	 * 
	 * name
	 * email
	 * email_verified
	 * 
	 *
	 * @return The supported claim names. Should not include the reserved
	 *         {@code sub} (subject) claim name.
	 */
	Set supportedClaims();
}