SSOData (com.staffbase:plugins-sdk-java 1.2.7 API)

java.lang.Object
- com.staffbase.plugins.sdk.sso.SSOData

```
public class SSOData
extends Object
```
A container for the data transmitted from staffbase to a plugin using staffbase's single-sign-on methodology.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_AUDIENCE` The key in the JWT claims for fetching the audience of the request.
`static String`	`KEY_BRANCH_ID` The key in the JWT claims for the fetching the requested branch id for the installation
`static String`	`KEY_BRANCH_SLUG` The key in the JWT claims for the fetching the requested branch slug for the installation
`static String`	`KEY_ENTITY_TYPE` The key in the JWT claims for fetching the the type of the accessing entity.
`static String`	`KEY_INSTANCE_ID` The key in the JWT claims for fetching the requested plugin instance's unique id.
`static String`	`KEY_INSTANCE_NAME` The key in the JWT claims for fetching the requested plugin instance's name.
`static String`	`KEY_ISSUER` The key in the JWT claims for fetching the issuer name.
`static String`	`KEY_SESSION_ID` The key in the JWT claims for fetching a cipher of the session
`static String`	`KEY_TAGS` The key in the JWT claims for fetching the list of tags that are configured in the Staffbase app.
`static String`	`KEY_THEME_BACKGROUND_COLOR` The key in the JWT claims for fetching the color of the background that is configured in the Staffbase app.
`static String`	`KEY_THEME_TEXT_COLOR` The key in the JWT claims for fetching the color of the text that is configured in the Staffbase app.
`static String`	`KEY_USER_EXTERNAL_ID` The key in the JWT claims for fetching the requesting user's id in an external system.
`static String`	`KEY_USER_FIRST_NAME` The key in the JWT claims for fetching the requesting user's first name.
`static String`	`KEY_USER_FULL_NAME` The key in the JWT claims for fetching the requesting user's full name.
`static String`	`KEY_USER_ID` The key in the JWT claims for fetching the requesting user's unique id.
`static String`	`KEY_USER_LAST_NAME` The key in the JWT claims for fetching the requesting user's last name.
`static String`	`KEY_USER_LOCALE` The key in the JWT claims for fetching the requesting user's locale settings.
`static String`	`KEY_USER_PRIMARY_EMAIL_ADDRESS` The key in the JWT claims for fetching the requesting user's primary email address.
`static String`	`KEY_USER_ROLE` The key in the JWT claims for fetching the requesting users role.
`static String`	`KEY_USER_USERNAME` The key in the JWT claims for fetching the requesting user's username.
`static String`	`REMOTE_CALL_DELETE` The user id/subject to identify if the SSO call is an instance deletion call.
`static String`	`ROLE_EDITOR` The name of the role which is sent by staffbase to a plugin, if the requesting user may alter the plugin's contents, i.e.

Constructor Summary

Constructors
Constructor and Description

SSOData(org.jose4j.jwt.JwtClaims jwtClaims)
Constructor of the SSOData class

Constructors
Constructor and Description
`SSOData(org.jose4j.jwt.JwtClaims jwtClaims)` Constructor of the SSOData class

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<String>`	`getAudience()` Get the name of the audience the staffbase's SSO data is dedicated.
`String`	`getBranchID()` Get the branch identifier of the installation
`String`	`getBranchSlug()` Get the name of the branch an installation belongs to
`Optional<String>`	`getEntityType()` Get the type of the accessing entity making the request using staffbase's SSO.
`String`	`getInstanceID()` Get the unique id of the specific plugin instance that was requested using staffbase's SSO.
`Optional<String>`	`getInstanceName()` Get the Name of the specific plugin instance that was requested using staffbase's SSO.
`Optional<String>`	`getIssuer()` Get the name of the issuing authority for Stabase's SSO .
`Optional<String>`	`getSessionId()` Get a cipher of the session id that was requested using staffbase's SSO.
`Optional<List<String>>`	`getTags()` Get the tags of the user in regards of the requested `instanceID`.
`Optional<String>`	`getThemeBackgroundColor()` Get the color of the background that is configured in the Staffbase app.
`Optional<String>`	`getThemeTextColor()` Get the color of the text that is configured in the Staffbase app.
`Optional<String>`	`getUserExternalID()` Get the id of the requesting user in an external system, if given.
`Optional<String>`	`getUserFirstName()` Get the first, i.e.
`Optional<String>`	`getUserFullName()` Get the full name of the user making the request using staffbase's SSO.
`Optional<String>`	`getUserID()` Get the unique id of the staffbase user making the request to the plugin using staffbase's SSO.
`Optional<String>`	`getUserLastName()` Get the last, i.e.
`Optional<Locale>`	`getUserLocale()` Get the locale of the user requesting the plugin instance.
`Optional<String>`	`getUserLocaleAsString()` Get the locale of the user requesting the plugin instance as the originally transmitted string.
`Optional<String>`	`getUserPrimaryEmailAddress()` Get the primary email address of the requesting user, if given.
`Optional<String>`	`getUserRole()` Get the role of the user in regards of the requested `instanceID`.
`Optional<String>`	`getUserUsername()` Get the username of the requesting user, if given.
`boolean`	`isDeleteInstanceCall()` Check if the SSO call is an instance deletion call.
`boolean`	`isEditor()` Check whether the requesting user is configured as an editor of the requested plugin instance.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - KEY_BRANCH_ID
```
public static final String KEY_BRANCH_ID
```
    The key in the JWT claims for the fetching the requested branch id for the installation
    
    See Also:
    
    Constant Field Values
  - KEY_BRANCH_SLUG
```
public static final String KEY_BRANCH_SLUG
```
    The key in the JWT claims for the fetching the requested branch slug for the installation
    
    See Also:
    
    Constant Field Values
  - ROLE_EDITOR
```
public static final String ROLE_EDITOR
```
    The name of the role which is sent by staffbase to a plugin, if the requesting user may alter the plugin's contents, i.e. has an editing permission to the specific plugin instance.
    
    See Also:
    
    Constant Field Values
  - REMOTE_CALL_DELETE
```
public static final String REMOTE_CALL_DELETE
```
    The user id/subject to identify if the SSO call is an instance deletion call.
    
    See Also:
    
    Constant Field Values
  - KEY_INSTANCE_ID
```
public static final String KEY_INSTANCE_ID
```
    The key in the JWT claims for fetching the requested plugin instance's unique id.
    
    See Also:
    
    Constant Field Values
  - KEY_SESSION_ID
```
public static final String KEY_SESSION_ID
```
    The key in the JWT claims for fetching a cipher of the session
    
    See Also:
    
    Constant Field Values
  - KEY_USER_ID
```
public static final String KEY_USER_ID
```
    The key in the JWT claims for fetching the requesting user's unique id.
    
    See Also:
    
    Constant Field Values
  - KEY_USER_EXTERNAL_ID
```
public static final String KEY_USER_EXTERNAL_ID
```
    The key in the JWT claims for fetching the requesting user's id in an external system.
    
    See Also:
    
    Constant Field Values
  - KEY_USER_USERNAME
```
public static final String KEY_USER_USERNAME
```
    The key in the JWT claims for fetching the requesting user's username.
    
    See Also:
    
    Constant Field Values
  - KEY_USER_PRIMARY_EMAIL_ADDRESS
```
public static final String KEY_USER_PRIMARY_EMAIL_ADDRESS
```
    The key in the JWT claims for fetching the requesting user's primary email address.
    
    See Also:
    
    Constant Field Values
  - KEY_USER_FIRST_NAME
```
public static final String KEY_USER_FIRST_NAME
```
    The key in the JWT claims for fetching the requesting user's first name.
    
    See Also:
    
    Constant Field Values
  - KEY_USER_LAST_NAME
```
public static final String KEY_USER_LAST_NAME
```
    The key in the JWT claims for fetching the requesting user's last name.
    
    See Also:
    
    Constant Field Values
  - KEY_USER_ROLE
```
public static final String KEY_USER_ROLE
```
    The key in the JWT claims for fetching the requesting users role.
    
    See Also:
    
    Constant Field Values
  - KEY_USER_LOCALE
```
public static final String KEY_USER_LOCALE
```
    The key in the JWT claims for fetching the requesting user's locale settings.
    
    See Also:
    
    Constant Field Values
  - KEY_ISSUER
```
public static final String KEY_ISSUER
```
    The key in the JWT claims for fetching the issuer name.
    
    See Also:
    
    Constant Field Values
  - KEY_AUDIENCE
```
public static final String KEY_AUDIENCE
```
    The key in the JWT claims for fetching the audience of the request.
    
    See Also:
    
    Constant Field Values
  - KEY_INSTANCE_NAME
```
public static final String KEY_INSTANCE_NAME
```
    The key in the JWT claims for fetching the requested plugin instance's name.
    
    See Also:
    
    Constant Field Values
  - KEY_USER_FULL_NAME
```
public static final String KEY_USER_FULL_NAME
```
    The key in the JWT claims for fetching the requesting user's full name.
    
    See Also:
    
    Constant Field Values
  - KEY_ENTITY_TYPE
```
public static final String KEY_ENTITY_TYPE
```
    The key in the JWT claims for fetching the the type of the accessing entity.
    
    See Also:
    
    Constant Field Values
  - KEY_THEME_TEXT_COLOR
```
public static final String KEY_THEME_TEXT_COLOR
```
    The key in the JWT claims for fetching the color of the text that is configured in the Staffbase app.
    
    See Also:
    
    Constant Field Values
  - KEY_THEME_BACKGROUND_COLOR
```
public static final String KEY_THEME_BACKGROUND_COLOR
```
    The key in the JWT claims for fetching the color of the background that is configured in the Staffbase app.
    
    See Also:
    
    Constant Field Values
  - KEY_TAGS
```
public static final String KEY_TAGS
```
    The key in the JWT claims for fetching the list of tags that are configured in the Staffbase app.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SSOData
```
public SSOData(org.jose4j.jwt.JwtClaims jwtClaims)
        throws org.jose4j.jwt.MalformedClaimException
```
    Constructor of the SSOData class
    
    Parameters:
    
    jwtClaims - The claims of an decoded JWT token
    
    Throws:
    
    org.jose4j.jwt.MalformedClaimException - The jwt token is invalid
- Method Detail
  - getBranchID
```
public String getBranchID()
```
    Get the branch identifier of the installation
    
    Returns:
    
    the id to know which branch an installation belongs to
    
    See Also:
    
    branchID
  - getBranchSlug
```
public String getBranchSlug()
```
    Get the name of the branch an installation belongs to
    
    Returns:
    
    the name of the branch an installation belongs to
    
    See Also:
    
    branchSlug
  - getIssuer
```
public Optional<String> getIssuer()
```
    Get the name of the issuing authority for Stabase's SSO .
    
    Returns:
    
    the name of the issuing authority
    
    See Also:
    
    issuer
  - getAudience
```
public Optional<String> getAudience()
```
    Get the name of the audience the staffbase's SSO data is dedicated.
    
    Returns:
    
    the name of the audience the data is dedicated to
    
    See Also:
    
    audience
  - getInstanceName
```
public Optional<String> getInstanceName()
```
    Get the Name of the specific plugin instance that was requested using staffbase's SSO.
    
    Returns:
    
    the Name of the specific plugin instance
    
    See Also:
    
    instanceName
  - getSessionId
```
public Optional<String> getSessionId()
```
    Get a cipher of the session id that was requested using staffbase's SSO.
    
    Returns:
    
    a cipher of the session id
    
    See Also:
    
    sessionID
  - getUserFullName
```
public Optional<String> getUserFullName()
```
    Get the full name of the user making the request using staffbase's SSO.
    
    Returns:
    
    the full name of the user
    
    See Also:
    
    userFullName
  - getEntityType
```
public Optional<String> getEntityType()
```
    Get the type of the accessing entity making the request using staffbase's SSO.
    
    Returns:
    
    type of the accessing entity
    
    See Also:
    
    entityType
  - getThemeTextColor
```
public Optional<String> getThemeTextColor()
```
    Get the color of the text that is configured in the Staffbase app.
    
    Returns:
    
    the hex color of the text
    
    See Also:
    
    themeTextColor
  - getThemeBackgroundColor
```
public Optional<String> getThemeBackgroundColor()
```
    Get the color of the background that is configured in the Staffbase app.
    
    Returns:
    
    the hex color of the background
    
    See Also:
    
    themeBackgroundColor
  - getInstanceID
```
public String getInstanceID()
```
    Get the unique id of the specific plugin instance that was requested using staffbase's SSO.
    
    Returns:
    
    requested plugin instance
    
    See Also:
    
    instanceID
  - getUserID
```
public Optional<String> getUserID()
```
    Get the unique id of the staffbase user making the request to the plugin using staffbase's SSO.
    
    Returns:
    
    the unique id of the requesting user
    
    See Also:
    
    userID
  - getUserExternalID
```
public Optional<String> getUserExternalID()
```
    Get the id of the requesting user in an external system, if given.
    
    Returns:
    
    the requesting user's id in an external system
    
    See Also:
    
    userExternalID
  - getUserUsername
```
public Optional<String> getUserUsername()
```
    Get the username of the requesting user, if given.
    
    Returns:
    
    the requesting user's username
    
    See Also:
    
    userUsername
  - getUserPrimaryEmailAddress
```
public Optional<String> getUserPrimaryEmailAddress()
```
    Get the primary email address of the requesting user, if given.
    
    Returns:
    
    the requesting user's primary email address
    
    See Also:
    
    userPrimaryEmailAddress
  - getUserFirstName
```
public Optional<String> getUserFirstName()
```
    Get the first, i.e. given name of the user making the request using staffbase's SSO.
    
    Returns:
    
    the requesting user's first name
    
    See Also:
    
    userFirstName
  - getUserLastName
```
public Optional<String> getUserLastName()
```
    Get the last, i.e. family name of the user making the request using staffbase's SSO.
    
    Returns:
    
    the requesting user's last name
    
    See Also:
    
    userLastName
  - getUserLocaleAsString
```
public Optional<String> getUserLocaleAsString()
```
    Get the locale of the user requesting the plugin instance as the originally transmitted string.
    
    Returns:
    
    the locale of the requesting user
    
    See Also:
    
    userLocale
  - getUserLocale
```
public Optional<Locale> getUserLocale()
```
    Get the locale of the user requesting the plugin instance.
    
    Returns:
    
    the locale of the requesting user
    
    See Also:
    
    userLocale
  - getUserRole
```
public Optional<String> getUserRole()
```
    Get the role of the user in regards of the requested instanceID. If the requesting user does have admin permissions, this value is set to "editor".
    
    Returns:
    
    the requesting user's access role
    
    See Also:
    
    userRole
  - isEditor
```
public boolean isEditor()
```
    Check whether the requesting user is configured as an editor of the requested plugin instance.
    
    Returns:
    
    true if the requesting user is an editor.
    
    See Also:
    
    userRole
  - isDeleteInstanceCall
```
public boolean isDeleteInstanceCall()
```
    Check if the SSO call is an instance deletion call. If an editor deletes a plugin instance in Staffbase, this will be true.
    
    Returns:
    
    true if the SSO call is an instance deletion call
  - getTags
```
public Optional<List<String>> getTags()
```
    Get the tags of the user in regards of the requested instanceID. If the requesting user does have admin permissions, this value is set to "editor".
    
    Returns:
    
    the requesting user's tags
    
    See Also:
    
    tags
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SSOData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEY_BRANCH_ID

KEY_BRANCH_SLUG

ROLE_EDITOR

REMOTE_CALL_DELETE

KEY_INSTANCE_ID

KEY_SESSION_ID

KEY_USER_ID

KEY_USER_EXTERNAL_ID

KEY_USER_USERNAME

KEY_USER_PRIMARY_EMAIL_ADDRESS

KEY_USER_FIRST_NAME

KEY_USER_LAST_NAME

KEY_USER_ROLE

KEY_USER_LOCALE

KEY_ISSUER

KEY_AUDIENCE

KEY_INSTANCE_NAME

KEY_USER_FULL_NAME

KEY_ENTITY_TYPE

KEY_THEME_TEXT_COLOR

KEY_THEME_BACKGROUND_COLOR

KEY_TAGS

Constructor Detail

SSOData

Method Detail

getBranchID

getBranchSlug

getIssuer

getAudience

getInstanceName

getSessionId

getUserFullName

getEntityType

getThemeTextColor

getThemeBackgroundColor

getInstanceID

getUserID

getUserExternalID

getUserUsername

getUserPrimaryEmailAddress

getUserFirstName

getUserLastName

getUserLocaleAsString

getUserLocale

getUserRole

isEditor

isDeleteInstanceCall

getTags

toString