io.confluent.security.trustservice.store

Interface TrustWriter

public interface TrustWriter

Method Summary

Modifier and Type	Method and Description
CompletionStage<Void>	addIdentityPool(Optional<Principal> requesterPrincipal, String poolId, int version, String issuer, String jwksEndpoint, String subjectClaim, String serviceAccount, String policy, String orgId, String reason) Adds a new IdentityPool record.
default CompletionStage<Void>	addIdentityPool(String poolId, int version, String issuer, String jwksEndpoint, String subjectClaim, String serviceAccount, String policy, String orgId)
CompletionStage<Void>	addJwks(Optional<Principal> requesterPrincipal, String jwtIssuer, String jwksEndpoint, org.jose4j.jwk.JsonWebKeySet jwks, String reason) Adds a new Jwks record.
default CompletionStage<Void>	addJwks(String jwtIssuer, String jwksEndpoint, org.jose4j.jwk.JsonWebKeySet jwks)
CompletionStage<Void>	addRefreshTokenInfo(Optional<Principal> requesterPrincipal, String issuer, String encryptedRefreshToken, long issuedAt, String subClaim, String sessionId) Adds refresh token information
default CompletionStage<Void>	addRefreshTokenInfo(String issuer, String encryptedRefreshToken, long issuedAt, String subClaim, String sessionId)
CompletionStage<Void>	removeIdentityPool(Optional<Principal> requesterPrincipal, String poolId, String reason) Removes an IdentityPool record.
default CompletionStage<Void>	removeIdentityPool(String poolId)
CompletionStage<Void>	removeJwks(Optional<Principal> requesterPrincipal, String jwtIssuer, String jwksEndpoint, String reason) Removes a Jwks
default CompletionStage<Void>	removeJwks(String jwtIssuer, String jwksEndpoint)
CompletionStage<Void>	removeRefreshTokenInfo(Optional<Principal> requesterPrincipal, String issuer, String subClaim)
default CompletionStage<Void>	removeRefreshTokenInfo(String issuer, String subClaim)
CompletionStage<Void>	replaceIdentityPool(Optional<Principal> requesterPrincipal, String poolId, int version, String issuer, String jwksEndpoint, String subjectClaim, String serviceAccount, String policy, String orgId, String reason) Replaces an IdentityPool
default CompletionStage<Void>	replaceIdentityPool(String poolId, int version, String issuer, String jwksEndpoint, String subjectClaim, String serviceAccount, String policy, String orgId)
CompletionStage<Void>	replaceJwks(Optional<Principal> requesterPrincipal, String jwtIssuer, String jwksEndpoint, org.jose4j.jwk.JsonWebKeySet jwks, String reason) Replaces a Jwks
default CompletionStage<Void>	replaceJwks(String jwtIssuer, String jwksEndpoint, org.jose4j.jwk.JsonWebKeySet jwks)
CompletionStage<Void>	replaceRefreshTokenInfo(Optional<Principal> requesterPrincipal, String issuer, String encryptedRefreshToken, long issuedAt, String subClaim, String sessionId)
default CompletionStage<Void>	replaceRefreshTokenInfo(String issuer, String encryptedRefreshToken, long issuedAt, String subClaim, String sessionId)

Method Detail

addJwks

CompletionStage<Void> addJwks(Optional<Principal> requesterPrincipal,
                              String jwtIssuer,
                              String jwksEndpoint,
                              org.jose4j.jwk.JsonWebKeySet jwks,
                              String reason)

Adds a new Jwks record.

Parameters:

requesterPrincipal - Optional principal of the requester

jwtIssuer - JsonWebToken jwtIssuer identifier

jwksEndpoint - JWKS URI for getting JWKS from issuer

jwks - JsonWebKeySet used for verifying token signatures

Returns:

a stage that is completed when update completes

Throws:

IllegalArgumentException - if scope is invalid.

addJwks

default CompletionStage<Void> addJwks(String jwtIssuer,
                                      String jwksEndpoint,
                                      org.jose4j.jwk.JsonWebKeySet jwks)

removeJwks

CompletionStage<Void> removeJwks(Optional<Principal> requesterPrincipal,
                                 String jwtIssuer,
                                 String jwksEndpoint,
                                 String reason)

Removes a Jwks

Parameters:

requesterPrincipal - Optional principal of the requester

jwtIssuer - JsonWebToken jwtIssuer identifier

jwksEndpoint - JWKS URI for getting JWKS from issuer

Returns:

a stage that is completed when update completes

Throws:

IllegalArgumentException - if scope is invalid.

removeJwks

default CompletionStage<Void> removeJwks(String jwtIssuer,
                                         String jwksEndpoint)

replaceJwks

CompletionStage<Void> replaceJwks(Optional<Principal> requesterPrincipal,
                                  String jwtIssuer,
                                  String jwksEndpoint,
                                  org.jose4j.jwk.JsonWebKeySet jwks,
                                  String reason)

Replaces a Jwks

Parameters:

requesterPrincipal - Optional principal of the requester

jwtIssuer - JsonWebToken jwtIssuer identifier

jwksEndpoint - Endpoint JWKS is retrieved from

jwks - Collection of Json Web Keys used for verifying token signatures

Returns:

a stage that is completed when update completes

Throws:

IllegalArgumentException - if scope is invalid.

replaceJwks

default CompletionStage<Void> replaceJwks(String jwtIssuer,
                                          String jwksEndpoint,
                                          org.jose4j.jwk.JsonWebKeySet jwks)

addIdentityPool

CompletionStage<Void> addIdentityPool(Optional<Principal> requesterPrincipal,
                                      String poolId,
                                      int version,
                                      String issuer,
                                      String jwksEndpoint,
                                      String subjectClaim,
                                      String serviceAccount,
                                      String policy,
                                      String orgId,
                                      String reason)

Adds a new IdentityPool record.

Parameters:

requesterPrincipal - Optional principal of the requester

poolId - IdentityPool identifier

version - Indicates which version this record corresponds to.

issuer - Issuer bound to this identityPool

jwksEndpoint - bound to this identityPool

subjectClaim - claim containing the authentication identity

serviceAccount - Service account bound to this identityPool

policy - IdentityPool trust policy expression

orgId - IdentityPool organization ID expression

Returns:

a stage that is completed when update completes

Throws:

IllegalArgumentException - if scope is invalid.

addIdentityPool

default CompletionStage<Void> addIdentityPool(String poolId,
                                              int version,
                                              String issuer,
                                              String jwksEndpoint,
                                              String subjectClaim,
                                              String serviceAccount,
                                              String policy,
                                              String orgId)

removeIdentityPool

CompletionStage<Void> removeIdentityPool(Optional<Principal> requesterPrincipal,
                                         String poolId,
                                         String reason)

Removes an IdentityPool record.

Parameters:

requesterPrincipal - Optional principal of the requester

poolId - IdentityPool identifier

Returns:

a stage that is completed when update completes

Throws:

IllegalArgumentException - if scope is invalid.

removeIdentityPool

default CompletionStage<Void> removeIdentityPool(String poolId)

replaceIdentityPool

CompletionStage<Void> replaceIdentityPool(Optional<Principal> requesterPrincipal,
                                          String poolId,
                                          int version,
                                          String issuer,
                                          String jwksEndpoint,
                                          String subjectClaim,
                                          String serviceAccount,
                                          String policy,
                                          String orgId,
                                          String reason)

Replaces an IdentityPool

Parameters:

requesterPrincipal - Optional principal of the requester

poolId - IdentityPool identifier

version - Indicates which version this record corresponds to.

issuer - Issuer bound to this identityPool

jwksEndpoint - JWKS endpoint bound to this identityPool

subjectClaim - claim containing the authentication identity

serviceAccount - Service account bound to this identityPool

policy - IdentityPool trust policy expression

orgId - IdentityPool organization ID expression

Returns:

a stage that is completed when update completes

Throws:

IllegalArgumentException - if scope is invalid.

replaceIdentityPool

default CompletionStage<Void> replaceIdentityPool(String poolId,
                                                  int version,
                                                  String issuer,
                                                  String jwksEndpoint,
                                                  String subjectClaim,
                                                  String serviceAccount,
                                                  String policy,
                                                  String orgId)

addRefreshTokenInfo

CompletionStage<Void> addRefreshTokenInfo(Optional<Principal> requesterPrincipal,
                                          String issuer,
                                          String encryptedRefreshToken,
                                          long issuedAt,
                                          String subClaim,
                                          String sessionId)

Adds refresh token information

Parameters:

requesterPrincipal - Optional principal of the requester

issuer - The issuer of the refresh token or issuer url of IdP

encryptedRefreshToken - The encrypted refresh token string

issuedAt - The issued at time of the refresh token

subClaim - The subject associated with the refresh token

sessionId - The id of session in which current refresh token is issued

Returns:

a CompletionStage that represents the completion of the operation

Throws:

IllegalArgumentException - if scope is invalid.

addRefreshTokenInfo

default CompletionStage<Void> addRefreshTokenInfo(String issuer,
                                                  String encryptedRefreshToken,
                                                  long issuedAt,
                                                  String subClaim,
                                                  String sessionId)

removeRefreshTokenInfo

CompletionStage<Void> removeRefreshTokenInfo(Optional<Principal> requesterPrincipal,
                                             String issuer,
                                             String subClaim)

removeRefreshTokenInfo

default CompletionStage<Void> removeRefreshTokenInfo(String issuer,
                                                     String subClaim)

replaceRefreshTokenInfo

CompletionStage<Void> replaceRefreshTokenInfo(Optional<Principal> requesterPrincipal,
                                              String issuer,
                                              String encryptedRefreshToken,
                                              long issuedAt,
                                              String subClaim,
                                              String sessionId)

replaceRefreshTokenInfo

default CompletionStage<Void> replaceRefreshTokenInfo(String issuer,
                                                      String encryptedRefreshToken,
                                                      long issuedAt,
                                                      String subClaim,
                                                      String sessionId)