com.aquaticinformatics.aquarius.sdk.timeseries.servicemodels

Class Provisioning.OpenIdConnectRelyingPartyConfiguration

java.lang.Object

com.aquaticinformatics.aquarius.sdk.timeseries.servicemodels.Provisioning.OpenIdConnectRelyingPartyConfiguration

Enclosing class:

Provisioning

public static class Provisioning.OpenIdConnectRelyingPartyConfiguration
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
String	ClientIdentifier The Relying Party client identifier
String	DisplayName Short display name of the identity provider.
List<String>	HostedDomains Optional list of hosted domains, supported for Google only
String	IdentifierClaim Name of an ID token claim to use as the unique identifier for OpenID Connect users.
String	IssuerIdentifier Issuer identifier
String	OptionalIssuerDiscoveryUri Optionally specify the full URI for the Issuer Discovery document including the Issuer Identifier.
String	RedirectUri The redirection URI for the authorization response; e.g.
List<String>	Scopes If not specified, defaults to 'openid', the standard scope required by the protocol.

Constructor Summary

Constructors

Constructor and Description
OpenIdConnectRelyingPartyConfiguration()

Method Summary

Modifier and Type	Method and Description
String	getClientIdentifier()
String	getDisplayName()
List<String>	getHostedDomains()
String	getIdentifierClaim()
String	getIssuerIdentifier()
String	getOptionalIssuerDiscoveryUri()
String	getRedirectUri()
List<String>	getScopes()
Provisioning.OpenIdConnectRelyingPartyConfiguration	setClientIdentifier(String value)
Provisioning.OpenIdConnectRelyingPartyConfiguration	setDisplayName(String value)
Provisioning.OpenIdConnectRelyingPartyConfiguration	setHostedDomains(List<String> value)
Provisioning.OpenIdConnectRelyingPartyConfiguration	setIdentifierClaim(String value)
Provisioning.OpenIdConnectRelyingPartyConfiguration	setIssuerIdentifier(String value)
Provisioning.OpenIdConnectRelyingPartyConfiguration	setOptionalIssuerDiscoveryUri(String value)
Provisioning.OpenIdConnectRelyingPartyConfiguration	setRedirectUri(String value)
Provisioning.OpenIdConnectRelyingPartyConfiguration	setScopes(List<String> value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IssuerIdentifier

public String IssuerIdentifier

Issuer identifier

ClientIdentifier

public String ClientIdentifier

The Relying Party client identifier

RedirectUri

public String RedirectUri

The redirection URI for the authorization response; e.g. 'https://my-domain/AQUARIUS/apps/v1/auth/openidconnect'. Must exactly match what is specified in the OpenID Connect client for the provider used.

Scopes

public List<String> Scopes

If not specified, defaults to 'openid', the standard scope required by the protocol.

HostedDomains

public List<String> HostedDomains

Optional list of hosted domains, supported for Google only

IdentifierClaim

public String IdentifierClaim

Name of an ID token claim to use as the unique identifier for OpenID Connect users. The default behaviour is to use 'sub', the standard subject identifier claim, which is suitable for most configurations. Options vary by OpenID Connect provider. Note that if this is changed after OpenID Connect users are registered, they will not be able to login until their identifiers are updated.

OptionalIssuerDiscoveryUri

public String OptionalIssuerDiscoveryUri

Optionally specify the full URI for the Issuer Discovery document including the Issuer Identifier. If empty, the discovery URI is composed as '{IssuerIdentifier}/.well-known/openid-configuration' which is suitable for most configurations. Specify the URI explicitly if additional query parameters are needed or a non-standard discovery URI is used. For Azure AD environments that use custom claims, the '?appid={ClientIdentifier}' query string must be include in the URI; e.g. 'https://login.microsoftonline.com/{IssuerUniqueId}/v2.0/.well-known/openid-configuration?appid={ClientIdentifier}'.

DisplayName

public String DisplayName

Short display name of the identity provider. If 'Google' or 'Microsoft', an appropriate icon will be displayed on the sign-in page.

Constructor Detail

OpenIdConnectRelyingPartyConfiguration

public OpenIdConnectRelyingPartyConfiguration()

Method Detail

getIssuerIdentifier

public String getIssuerIdentifier()

setIssuerIdentifier

public Provisioning.OpenIdConnectRelyingPartyConfiguration setIssuerIdentifier(String value)

getClientIdentifier

public String getClientIdentifier()

setClientIdentifier

public Provisioning.OpenIdConnectRelyingPartyConfiguration setClientIdentifier(String value)

getRedirectUri

public String getRedirectUri()

setRedirectUri

public Provisioning.OpenIdConnectRelyingPartyConfiguration setRedirectUri(String value)

getScopes

public List<String> getScopes()

setScopes

public Provisioning.OpenIdConnectRelyingPartyConfiguration setScopes(List<String> value)

getHostedDomains

public List<String> getHostedDomains()

setHostedDomains

public Provisioning.OpenIdConnectRelyingPartyConfiguration setHostedDomains(List<String> value)

getIdentifierClaim

public String getIdentifierClaim()

setIdentifierClaim

public Provisioning.OpenIdConnectRelyingPartyConfiguration setIdentifierClaim(String value)

getOptionalIssuerDiscoveryUri

public String getOptionalIssuerDiscoveryUri()

setOptionalIssuerDiscoveryUri

public Provisioning.OpenIdConnectRelyingPartyConfiguration setOptionalIssuerDiscoveryUri(String value)

getDisplayName

public String getDisplayName()

setDisplayName

public Provisioning.OpenIdConnectRelyingPartyConfiguration setDisplayName(String value)