SSOIServerCredentials (Web API 2021)

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

OidcSSOIServerCredentials, SAMLSSOIServerCredentials
```
public interface SSOIServerCredentials
extends java.io.Serializable
```
This interface represents the credentials for SSO. Implementations of this interface will be used to establish session with the IServer.

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface SSOIServerCredentials.Group
This interface represents the user group information

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String SESSION_ATT_NAME
The key used to store/retrieve SSO credentials from HTTP session

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`getDisplayName()`	The display name of the user
`java.lang.String`	`getDistinguishedName()`	The distinguished name of the user
`java.lang.String`	`getEmail()`	The email of the user
`java.util.List<SSOIServerCredentials.Group>`	`getGroups()`	The groups of the user.
`java.lang.String`	`getIdToken()`	The id token of the user, for OIDC authentication
`java.lang.String`	`getUserId()`	The id of the user.
`boolean`	`isValid()`	Whether the credential is valid

- Field Detail
  - SESSION_ATT_NAME
```
static final java.lang.String SESSION_ATT_NAME
```
    The key used to store/retrieve SSO credentials from HTTP session
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getUserId
```
java.lang.String getUserId()
```
    The id of the user.
    
    Returns:
  - getGroups
```
java.util.List<SSOIServerCredentials.Group> getGroups()
```
    The groups of the user.
    
    Returns:
  - getDistinguishedName
```
java.lang.String getDistinguishedName()
```
    The distinguished name of the user
    
    Returns:
  - isValid
```
boolean isValid()
```
    Whether the credential is valid
    
    Returns:
  - getDisplayName
```
java.lang.String getDisplayName()
```
    The display name of the user
    
    Returns:
  - getEmail
```
java.lang.String getEmail()
```
    The email of the user
    
    Returns:
  - getIdToken
```
java.lang.String getIdToken()
```
    The id token of the user, for OIDC authentication
    
    Returns: