C E G I K P R S T V

C

com.staffbase.plugins.sdk.sso - package com.staffbase.plugins.sdk.sso

com.staffbase.plugins.sdk.util - package com.staffbase.plugins.sdk.util

create(RSAPublicKey) - Static method in class com.staffbase.plugins.sdk.sso.SSOFacade

Initialize the facade using the given RSA public key

E

EXPECTED_CLAIM_INSTANCE_ID - Static variable in class com.staffbase.plugins.sdk.sso.SSOFacade

The name of the claim which holds the mandatory instance id for the single-sign-on attempt.

G

getAudience() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the name of the audience the staffbase's SSO data is dedicated.

getBranchID() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the branch identifier of the installation

getBranchSlug() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the name of the branch an installation belongs to

getEntityType() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the type of the accessing entity making the request using staffbase's SSO.

getInstanceID() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the unique id of the specific plugin instance that was requested using staffbase's SSO.

getInstanceName() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the Name of the specific plugin instance that was requested using staffbase's SSO.

getIssuer() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the name of the issuing authority for Stabase's SSO .

getSessionId() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get a cipher of the session id that was requested using staffbase's SSO.

getTags() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the tags of the user in regards of the requested SSOData.instanceID.

getThemeBackgroundColor() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the color of the background that is configured in the Staffbase app.

getThemeTextColor() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the color of the text that is configured in the Staffbase app.

getUserExternalID() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the id of the requesting user in an external system, if given.

getUserFirstName() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the first, i.e.

getUserFullName() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the full name of the user making the request using staffbase's SSO.

getUserID() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the unique id of the staffbase user making the request to the plugin using staffbase's SSO.

getUserLastName() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the last, i.e.

getUserLocale() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the locale of the user requesting the plugin instance.

getUserLocaleAsString() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the locale of the user requesting the plugin instance as the originally transmitted string.

getUserPrimaryEmailAddress() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the primary email address of the requesting user, if given.

getUserRole() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the role of the user in regards of the requested SSOData.instanceID.

getUserUsername() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Get the username of the requesting user, if given.

I

isDeleteInstanceCall() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Check if the SSO call is an instance deletion call.

isEditor() - Method in class com.staffbase.plugins.sdk.sso.SSOData

Check whether the requesting user is configured as an editor of the requested plugin instance.

K

KEY_AUDIENCE - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for fetching the audience of the request.

KEY_BRANCH_ID - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for the fetching the requested branch id for the installation

KEY_BRANCH_SLUG - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for the fetching the requested branch slug for the installation

KEY_ENTITY_TYPE - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for fetching the the type of the accessing entity.

KEY_INSTANCE_ID - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for fetching the requested plugin instance's unique id.

KEY_INSTANCE_NAME - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for fetching the requested plugin instance's name.

KEY_ISSUER - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for fetching the issuer name.

KEY_SESSION_ID - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for fetching a cipher of the session

KEY_TAGS - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for fetching the list of tags that are configured in the Staffbase app.

KEY_THEME_BACKGROUND_COLOR - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for fetching the color of the background that is configured in the Staffbase app.

KEY_THEME_TEXT_COLOR - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for fetching the color of the text that is configured in the Staffbase app.

KEY_USER_EXTERNAL_ID - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for fetching the requesting user's id in an external system.

KEY_USER_FIRST_NAME - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for fetching the requesting user's first name.

KEY_USER_FULL_NAME - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for fetching the requesting user's full name.

KEY_USER_ID - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for fetching the requesting user's unique id.

KEY_USER_LAST_NAME - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for fetching the requesting user's last name.

KEY_USER_LOCALE - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for fetching the requesting user's locale settings.

KEY_USER_PRIMARY_EMAIL_ADDRESS - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for fetching the requesting user's primary email address.

KEY_USER_ROLE - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for fetching the requesting users role.

KEY_USER_USERNAME - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The key in the JWT claims for fetching the requesting user's username.

P

parseLocale(String) - Static method in class com.staffbase.plugins.sdk.util.TextUtil

Parse a Locale from a string version as used in staffbase's SSO context.

R

REMOTE_CALL_DELETE - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

The user id/subject to identify if the SSO call is an instance deletion call.

ROLE_EDITOR - Static variable in class com.staffbase.plugins.sdk.sso.SSOData

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.

S

SSOData - Class in com.staffbase.plugins.sdk.sso

A container for the data transmitted from staffbase to a plugin using staffbase's single-sign-on methodology.

SSOData(JwtClaims) - Constructor for class com.staffbase.plugins.sdk.sso.SSOData

Constructor of the SSOData class

SSOException - Exception in com.staffbase.plugins.sdk.sso

Special exception expressing issues in the verification process of a single-sign-on attempt with staffbase.

SSOFacade - Class in com.staffbase.plugins.sdk.sso

Simple facade for handling staffbase's single-sign-on attempts and verifying the corresponding JWT data.

T

TextUtil - Class in com.staffbase.plugins.sdk.util

TextUtil() - Constructor for class com.staffbase.plugins.sdk.util.TextUtil

toString() - Method in class com.staffbase.plugins.sdk.sso.SSOData

V

verify(String) - Method in class com.staffbase.plugins.sdk.sso.SSOFacade

Verify and parse a single-sign-on attempt coming from the staffbase app.

C E G I K P R S T V