Serialized Form (The Samply Auth Data Transfer Objects 2.1.0-SNAPSHOT API)

Package de.samply.auth.client.jwt
- Class de.samply.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.auth.client.jwt.JWTAccessToken extends AbstractJWT implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.samply.auth.client.jwt.JWTAdfsAccessToken extends AbstractJWT implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.samply.auth.client.jwt.JWTException extends Exception implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.samply.auth.client.jwt.JWTHokToken extends AbstractJWT implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.samply.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.
- Class de.samply.auth.client.jwt.JWTInvalidSignatureFormatException extends JWTException implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.samply.auth.client.jwt.JWTKeyMissmatchException extends JWTException implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.samply.auth.client.jwt.JWTParseException extends JWTException implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.samply.auth.client.jwt.JWTRefreshToken extends AbstractJWT implements Serializable
  
  serialVersionUID:
  
  1L
Package de.samply.auth.rest
- Class de.samply.auth.rest.AccessTokenDTO extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - 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.
    - refreshToken
```
String refreshToken
```
      The refresh token can be used by the OAuth2 client to get a new access token. It has no expiration date.
    - tokenType
```
String tokenType
```
      This token type must be "Bearer" because the implicit flows are not supported in Samply Auth.
    - expiresIn
```
int expiresIn
```
      The number of seconds that the access token is valid.
- Class de.samply.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.auth.rest.ClientDescriptionDTO extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
      The clients name.
    - description
```
String description
```
      A more through description of this client.
    - clientId
```
String clientId
```
      The clients OAuth2 client ID.
    - redirectUrl
```
String redirectUrl
```
      The clients URL.
    - type
```
ClientType type
```
      The client type.
- Class de.samply.auth.rest.ClientListDTO extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - clients
```
Collection<E> clients
```
      The collection of clients known to this Auth component
- Class de.samply.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.auth.rest.LoginDTO extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - redirectUrl
```
String redirectUrl
```
      The redirect url for the client you requested.
    - code
```
String code
```
      The code the client needs.
- Class de.samply.auth.rest.LoginRequestDTO extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - clientId
```
String clientId
```
      The client ID.
- Class de.samply.auth.rest.OAuth2Discovery extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - application
```
String application
```
      The application name of the identity provider.
    - version
```
String version
```
      The version of the identity provider.
    - issuer
```
String issuer
```
      The issuer. This is usually the URL of this identity provider.
    - authorizationEndpoint
```
String authorizationEndpoint
```
      The user should be redirected to this URL
    - tokenEndpoint
```
String tokenEndpoint
```
      The token endpoint is used to get an access token.
    - scopesSupported
```
List<E> scopesSupported
```
      A list of all supported scopes by this identity provider.
    - jwksUri
```
String jwksUri
```
      The URL of the used keys by this identity provider. The keys are used to sign access tokens and OpenID tokens.
    - responseTypesSupported
```
List<E> responseTypesSupported
```
      The response types that are supported by this identity provider.
- Class de.samply.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.
    - n
```
String n
```
      The RSA modulus
    - e
```
String e
```
      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.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.auth.rest.RegistrationDTO extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - userId
```
int userId
```
      Your user ID
    - keyId
```
int keyId
```
      Your key ID
- Class de.samply.auth.rest.RegistrationRequestDTO extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - email
```
String email
```
      The email that may be used to verify this user manually.
    - name
```
String name
```
      The name of the user. May be the registrys name or a real name.
    - description
```
String description
```
      A description of the registry.
    - base64EncodedPublicKey
```
String base64EncodedPublicKey
```
      The base64 encoded public key that will be used to authenticate the application.
    - contactData
```
String contactData
```
      The contact data that is used for verification
    - usertype
```
Usertype usertype
```
      The usertype for the new user.
- Class de.samply.auth.rest.SignRequestDTO extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
      The code that you should sign using your private key.
    - expirationDate
```
long expirationDate
```
      The expiration date of this sign request. After this date, this sign request is invalid.
    - algorithm
```
String algorithm
```
      The algorithm that you need to used to sign the code.
- Class de.samply.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.auth.rest.UserDTO extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
      The users real name.
    - email
```
String email
```
      The users email.
    - id
```
String id
```
      His full ID in the identity provider
    - emailVerified
```
Boolean emailVerified
```
      If true, the users email is verified by Samply Auth.
    - externalLabel
```
String externalLabel
```
      This is the external identity providers label.
    - contactInformation
```
String contactInformation
```
      The contact informations of this user

Serialized Form

Package de.samply.auth.client.jwt

Class de.samply.auth.client.jwt.AbstractJWT extends Object implements Serializable

Serialized Fields

serialized

signatureValid

publicKey

Class de.samply.auth.client.jwt.JWTAccessToken extends AbstractJWT implements Serializable

Class de.samply.auth.client.jwt.JWTAdfsAccessToken extends AbstractJWT implements Serializable

Class de.samply.auth.client.jwt.JWTException extends Exception implements Serializable

Class de.samply.auth.client.jwt.JWTHokToken extends AbstractJWT implements Serializable

Class de.samply.auth.client.jwt.JWTIDToken extends AbstractJWT implements Serializable

Serialized Fields

clientId

Class de.samply.auth.client.jwt.JWTInvalidSignatureFormatException extends JWTException implements Serializable

Class de.samply.auth.client.jwt.JWTKeyMissmatchException extends JWTException implements Serializable

Class de.samply.auth.client.jwt.JWTParseException extends JWTException implements Serializable

Class de.samply.auth.client.jwt.JWTRefreshToken extends AbstractJWT implements Serializable

Package de.samply.auth.rest

Class de.samply.auth.rest.AccessTokenDTO extends Object implements Serializable

Serialized Fields

accessToken

idToken

refreshToken

tokenType

expiresIn

Class de.samply.auth.rest.AccessTokenRequestDTO extends Object implements Serializable

Serialized Fields

code

clientId

clientSecret

signature

refreshToken

extended

Class de.samply.auth.rest.ClientDescriptionDTO extends Object implements Serializable

Serialized Fields

name

description

clientId

redirectUrl

type

Class de.samply.auth.rest.ClientListDTO extends Object implements Serializable

Serialized Fields

clients

Class de.samply.auth.rest.KeyIdentificationDTO extends Object implements Serializable

Serialized Fields

keyId

sha512Hash

Class de.samply.auth.rest.LoginDTO extends Object implements Serializable

Serialized Fields

redirectUrl

code

Class de.samply.auth.rest.LoginRequestDTO extends Object implements Serializable

Serialized Fields

clientId

Class de.samply.auth.rest.OAuth2Discovery extends Object implements Serializable

Serialized Fields

application

version

issuer

authorizationEndpoint

tokenEndpoint

scopesSupported

jwksUri

responseTypesSupported

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

Serialized Fields

keyType

use

keyId

n

e

derFormat

base64DerFormat

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

Serialized Fields

keys

Class de.samply.auth.rest.RegistrationDTO extends Object implements Serializable

Serialized Fields

userId