IdentityProvider (Microfocus Android Mobile Native Application SDK Library)

```
public interface IdentityProvider
```
Defines an OAuth2 Identity Provider with all of its associated identifiers and end points.
An Identity Provider is uniquely defined by the host name plus the client identifier value.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PARAMETER_FORMATTING_TAG_ACCESSTOKEN`
`static java.lang.String`	`PARAMETER_FORMATTING_TAG_CLIENTID`
`static java.lang.String`	`PARAMETER_FORMATTING_TAG_CLIENTSECRET`
`static java.lang.String`	`PARAMETER_FORMATTING_TAG_REFRESHTOKEN`
`static java.lang.String`	`REVOCATION_TOKEN_METHOD_DEFAULT`
`static java.lang.String`	`REVOCATION_TOKEN_METHOD_GET`
`static java.lang.String`	`REVOCATION_TOKEN_METHOD_POST`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Uri`	`getAuthorizationEndPoint()` Get the OAuth2 authorization end point URL.
`java.lang.String`	`getClientId()` Get the OAuth2 client identifier.
`java.lang.String`	`getClientSecret()` Get the OAuth2 client secret.
`Uri`	`getDiscoveryEndPoint()` Get the OAuth2 discovery end point URL.
`java.lang.String`	`getHost()` Get the host name (domain name) as defined by the provider URL.
`Uri`	`getLogoutEndPoint()` Get the identity provider specific logout end point url.
`java.lang.String`	`getProviderUrl()` Get the provider URL of the OAuth2 server.
`Uri`	`getRedirectUri()` Get the OAuth2 redirect URI.
`Uri`	`getRegistrationEndPoint()` Get the OAuth2 client registration end point URL.
`java.lang.String`	`getScope()` Get the OAuth2 scope.
`Uri`	`getTokenEndPoint()` Get the OAuth2 token end point URL.
`Uri`	`getTokenRevocationEndPoint()` Get the refresh token revocation end point url.
`java.lang.String`	`getTokenRevocationMethod()` Get the refresh token revocation HTTP method: "POST" or "GET".
`java.lang.String`	`getTokenRevocationParameterFormatString()` Get the refresh token revocation parameter format string.
`Uri`	`getUserInfoEndPoint()` Get the OAuth2 user information end point URL.
`java.lang.String`	`toJson()` Get the JSON representation of this Identity Provider.

- Field Detail
  - REVOCATION_TOKEN_METHOD_POST
```
static final java.lang.String REVOCATION_TOKEN_METHOD_POST
```
    See Also:
    
    Constant Field Values
  - REVOCATION_TOKEN_METHOD_GET
```
static final java.lang.String REVOCATION_TOKEN_METHOD_GET
```
    See Also:
    
    Constant Field Values
  - REVOCATION_TOKEN_METHOD_DEFAULT
```
static final java.lang.String REVOCATION_TOKEN_METHOD_DEFAULT
```
    See Also:
    
    Constant Field Values
  - PARAMETER_FORMATTING_TAG_CLIENTID
```
static final java.lang.String PARAMETER_FORMATTING_TAG_CLIENTID
```
    See Also:
    
    Constant Field Values
  - PARAMETER_FORMATTING_TAG_CLIENTSECRET
```
static final java.lang.String PARAMETER_FORMATTING_TAG_CLIENTSECRET
```
    See Also:
    
    Constant Field Values
  - PARAMETER_FORMATTING_TAG_REFRESHTOKEN
```
static final java.lang.String PARAMETER_FORMATTING_TAG_REFRESHTOKEN
```
    See Also:
    
    Constant Field Values
  - PARAMETER_FORMATTING_TAG_ACCESSTOKEN
```
static final java.lang.String PARAMETER_FORMATTING_TAG_ACCESSTOKEN
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getProviderUrl
```
java.lang.String getProviderUrl()
```
    Get the provider URL of the OAuth2 server. The provider URL is the leftmost section of the URL including the scheme, domain name, and port.
    The URL will not contain an ending slash.
    
    Returns:
    
    The provider URL. Will never be null.
  - getHost
```
java.lang.String getHost()
```
    Get the host name (domain name) as defined by the provider URL.
    
    Returns:
    
    The host name. Will never be null.
  - getClientId
```
java.lang.String getClientId()
```
    Get the OAuth2 client identifier.
    
    Returns:
    
    The OAuth2 client identifier. Will never be null.
  - getClientSecret
```
java.lang.String getClientSecret()
```
    Get the OAuth2 client secret.
    
    Returns:
    
    The OAuth2 client secret. Will never be null.
  - getRedirectUri
```
Uri getRedirectUri()
```
    Get the OAuth2 redirect URI.
    
    Returns:
    
    The OAuth2 redirect URI. Will never be null.
  - getDiscoveryEndPoint
```
Uri getDiscoveryEndPoint()
```
    Get the OAuth2 discovery end point URL. A full URL will be returned where the leftmost part of the URL will be equal to the Provider URL.
    
    Returns:
    
    The OAuth2 discovery end point URL. May be null if the end point is not defined.
  - getRegistrationEndPoint
```
Uri getRegistrationEndPoint()
```
    Get the OAuth2 client registration end point URL. A full URL will be returned where the leftmost part of the URL will be equal to the Provider URL.
    
    Returns:
    
    The OAuth2 client registration end point URL. May be null if the end point is not defined.
  - getAuthorizationEndPoint
```
Uri getAuthorizationEndPoint()
```
    Get the OAuth2 authorization end point URL. A full URL will be returned where the leftmost part of the URL will be equal to the Provider URL. In a fully operational Identity Provider definition, this end point is required, but instances may be created where a discovery end point exists without authorization or token end points.
    
    Returns:
    
    The OAuth2 authorization end point URL. May be null if the end point is not defined.
  - getTokenEndPoint
```
Uri getTokenEndPoint()
```
    Get the OAuth2 token end point URL. A full URL will be returned where the leftmost part of the URL will be equal to the Provider URL. In a fully operational Identity Provider definition, this end point is required, but instances may be created where a discovery end point exists without authorization or token end points.
    
    Returns:
    
    The OAuth2 token end point URL. May be null if the end point is not defined.
  - getUserInfoEndPoint
```
Uri getUserInfoEndPoint()
```
    Get the OAuth2 user information end point URL. A full URL will be returned where the leftmost part of the URL will be equal to the Provider URL.
    
    Returns:
    
    The OAuth2 user information end point URL. May be null if the end point is not defined.
  - getLogoutEndPoint
```
Uri getLogoutEndPoint()
```
    Get the identity provider specific logout end point url. This is not an OAuth2 end point. It is an end point where the identity provider implementation will remove all authentication browser cookies for the current session. A full URL will be returned where the leftmost part of the URL will be equal to the Provider URL.
    
    Returns:
    
    The identity provider logout end point URL. May be null if the end point is not defined.
  - getTokenRevocationEndPoint
```
Uri getTokenRevocationEndPoint()
```
    Get the refresh token revocation end point url. A full URL will be returned where the leftmost part of the URL will be equal to the Provider URL.
    This is am optional parameter in that the identity provider may be configured without a refresh token revocation end point, but, if the client desires refresh token revocation to work, then all three refresh token revocation data items are required. These include this data item plus:
    getTokenRevocationMethod()
    getTokenRevocationParameterFormatString()
    
    Returns:
    
    The refresh token revocation end point URL. May be null if the end point is not defined.
  - getTokenRevocationMethod
```
java.lang.String getTokenRevocationMethod()
```
    Get the refresh token revocation HTTP method: "POST" or "GET".
    Implementation must ensure no other values may be set or returned.
    This is am optional parameter in that the identity provider may be configured without a refresh token revocation method, but, if the client desires refresh token revocation to work, then all three refresh token revocation data items are required. These include this data item plus:
    getTokenRevocationEndPoint()
    getTokenRevocationParameterFormatString()
    
    Returns:
    
    The refresh token revocation HTTP method. Defaults to "POST". Winn never return null.
  - getTokenRevocationParameterFormatString
```
java.lang.String getTokenRevocationParameterFormatString()
```
    Get the refresh token revocation parameter format string. A format string properly formatted for inclusion on a query string or in POST parameters. The available formatting tags are:
    PARAMETER_FORMATTING_TAG_CLIENTID
    PARAMETER_FORMATTING_TAG_CLIENTSECRET
    PARAMETER_FORMATTING_TAG_REFRESHTOKEN
    PARAMETER_FORMATTING_TAG_ACCESSTOKEN
    This is am optional parameter in that the identity provider may be configured without a refresh token revocation parameter format string, but, if the client desires refresh token revocation to work, then all three refresh token revocation data items are required. These include this data item plus:
    getTokenRevocationEndPoint()
    getTokenRevocationMethod()
    
    Returns:
    
    The refresh token parameter formatting string. May be null if the end point is not defined.
  - getScope
```
java.lang.String getScope()
```
    Get the OAuth2 scope. By specification this is a space delimited string.
    
    Returns:
    
    The OAuth2 scope.
  - toJson
```
java.lang.String toJson()
```
    Get the JSON representation of this Identity Provider.
    For the opposite method see ServiceContext.getIdentityProviderBuilder(String).
    
    Returns:
    
    The JSON representation of this Identity Provider. Will never be null.

Interface IdentityProvider

Field Summary

Method Summary

Field Detail

REVOCATION_TOKEN_METHOD_POST

REVOCATION_TOKEN_METHOD_GET

REVOCATION_TOKEN_METHOD_DEFAULT

PARAMETER_FORMATTING_TAG_CLIENTID

PARAMETER_FORMATTING_TAG_CLIENTSECRET

PARAMETER_FORMATTING_TAG_REFRESHTOKEN

PARAMETER_FORMATTING_TAG_ACCESSTOKEN

Method Detail

getProviderUrl

getHost

getClientId

getClientSecret

getRedirectUri

getDiscoveryEndPoint

getRegistrationEndPoint

getAuthorizationEndPoint

getTokenEndPoint

getUserInfoEndPoint

getLogoutEndPoint

getTokenRevocationEndPoint

getTokenRevocationMethod

getTokenRevocationParameterFormatString

getScope

toJson