Serialized Form

Package de.samply.bbmri.auth.client.jwt

Class de.samply.bbmri.auth.client.jwt.AbstractJwt extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

serialized

String serialized

The serialized Jwt.

signatureValid

boolean signatureValid

If true the signature is valid.

publicKey

PublicKey publicKey

The public key used to verify the JWTs signature.

Class de.samply.bbmri.auth.client.jwt.JwtAccessToken extends AbstractJwt implements Serializable

serialVersionUID:

1L

Class de.samply.bbmri.auth.client.jwt.JwtException extends Exception implements Serializable

serialVersionUID:

1L

Class de.samply.bbmri.auth.client.jwt.JwtIdToken extends AbstractJwt implements Serializable

serialVersionUID:

1L

Serialized Fields

clientId

String clientId

The client ID used to get this ID token. It is used to verify the audience.

roles

List<E> roles

The list of roles that the user is a member of.

Class de.samply.bbmri.auth.client.jwt.JwtInvalidSignatureFormatException extends JwtException implements Serializable

serialVersionUID:

1L

Class de.samply.bbmri.auth.client.jwt.JwtKeyMissmatchException extends JwtException implements Serializable

serialVersionUID:

1L

Class de.samply.bbmri.auth.client.jwt.JwtParseException extends JwtException implements Serializable

serialVersionUID:

1L

Class de.samply.bbmri.auth.client.jwt.JwtRefreshToken extends AbstractJwt implements Serializable

serialVersionUID:

1L

Package de.samply.bbmri.auth.rest

Class de.samply.bbmri.auth.rest.AccessTokenDto extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

tokenType

String tokenType

This token type must be "Bearer" because the implicit flows are not supported in Samply Auth.

refreshToken

String refreshToken

accessToken

String accessToken

The OAuth2 access token. In Samply.Auth this is a Jwt, signed with the identity providers private key. This access token contains information about the scopes this access token was issued for, the user ID (called subject in OAuth2 terminology) and other fields.

idToken

String idToken

The OAuth2 OpenID token. In Samply.Auth this is a Jwt, signed with the identity providers private key. This token contains various informations about the user, like his name or his email.

expiresIn

int expiresIn

The number of seconds that the access token is valid.

scope

String scope

The scopes this token is valid for.

Class de.samply.bbmri.auth.rest.AccessTokenRequestDto extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

The code your application got from the redirect.

clientId

String clientId

Your client ID, that has been assigned to you by the identity provider. Mandatory, if you want to use the code or the refresh token.

clientSecret

String clientSecret

Your client secret, that has been assigned to you by the identity provider. Mandatory, if you want to use the code or the refresh token.

signature

String signature

The base64 encoded signature of AccessTokenRequestDto.code. Generated with your private key. Mandatory, if you want to use your private key to authenticate.

refreshToken

String refreshToken

The refresh token you want to use in order to get a new access token.

extended

String extended

The extend token. If you don't want to get an extended access token, leave this field empty (null). You can get an extended token with a signature only.

Class de.samply.bbmri.auth.rest.KeyIdentificationDto extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

keyId

int keyId

The key ID you got when the public key has been registred.

sha512Hash

String sha512Hash

The public keys fingerprint. Use the SHA-512 hash on the DER formated public key.

Class de.samply.bbmri.auth.rest.OAuth2Key extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

keyType

String keyType

The key type, usually this is either RSA or EC.

use

String use

The usage of this key.

keyId

String keyId

The keys ID.

modulesN

String modulesN

The RSA modulus.

exponent

String exponent

The RSA public exponent.

derFormat

String derFormat

The Base64URL encoded DER formatted public key.

base64DerFormat

String base64DerFormat

The Base64 encoded DER formatted public key.

Class de.samply.bbmri.auth.rest.OAuth2Keys extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

keys

List<E> keys

The list of keys used by this identity provider.

Class de.samply.bbmri.auth.rest.RoleDto extends Object implements Serializable

Serialized Fields

name

String name

identifier

String identifier

description

String description

members

List<E> members

Class de.samply.bbmri.auth.rest.RoleListDto extends Object implements Serializable

Serialized Fields

roles

List<E> roles

Class de.samply.bbmri.auth.rest.TokenInfoDto extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

expirationDate

long expirationDate

The tokens expiration date. The token is invalid, if the expiration is in the past.

subject

String subject

The user ID. This is usually a URL of the issuer and an integer.

scope

List<E> scope

The list of scopes this access token may be used for.

jti

String jti

A random string. Ignore this.

notBefore

long notBefore

The date before which the access token is not valid.

issuedAt

long issuedAt

The date at which the access token was issued.

issuer

String issuer

The URL of the issuer.

Class de.samply.bbmri.auth.rest.UserDto extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

The users real name.

email

String email

The users email.

sub

String sub

The OpenID Connect subject.

phone

String phone

The phone number of the user.

groupNames

List<E> groupNames

Group names (collections) of a bbmri user.

Class de.samply.bbmri.auth.rest.UserListDto extends Object implements Serializable

serialVersionUID:

-4439834854837306186L

Serialized Fields

users

Collection<E> users