Package com.daml.ledger.api.v2.admin

Interface IdentityProviderConfigServiceOuterClass.IdentityProviderConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
IdentityProviderConfigServiceOuterClass.IdentityProviderConfig, IdentityProviderConfigServiceOuterClass.IdentityProviderConfig.Builder
Enclosing class:
IdentityProviderConfigServiceOuterClass
public static interface IdentityProviderConfigServiceOuterClass.IdentityProviderConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAudience()
    Specifies the audience of the JWT token.
    com.google.protobuf.ByteString
    getAudienceBytes()
    Specifies the audience of the JWT token.
    String
    getIdentityProviderId()
    The identity provider identifier Must be a valid LedgerString (as describe in ``value.proto``).
    com.google.protobuf.ByteString
    getIdentityProviderIdBytes()
    The identity provider identifier Must be a valid LedgerString (as describe in ``value.proto``).
    boolean
    getIsDeactivated()
    When set, the callers using JWT tokens issued by this identity provider are denied all access to the Ledger API.
    String
    getIssuer()
    Specifies the issuer of the JWT token.
    com.google.protobuf.ByteString
    getIssuerBytes()
    Specifies the issuer of the JWT token.
    String
    getJwksUrl()
    The JWKS (JSON Web Key Set) URL.
    com.google.protobuf.ByteString
    getJwksUrlBytes()
    The JWKS (JSON Web Key Set) URL.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getIdentityProviderId

      String getIdentityProviderId()
       The identity provider identifier
 Must be a valid LedgerString (as describe in ``value.proto``).
 Required
      string identity_provider_id = 1 [json_name = "identityProviderId"];
      Returns:
      The identityProviderId.

    • getIdentityProviderIdBytes

      com.google.protobuf.ByteString getIdentityProviderIdBytes()
       The identity provider identifier
 Must be a valid LedgerString (as describe in ``value.proto``).
 Required
      string identity_provider_id = 1 [json_name = "identityProviderId"];
      Returns:
      The bytes for identityProviderId.

    • getIsDeactivated

      boolean getIsDeactivated()
       When set, the callers using JWT tokens issued by this identity provider are denied all access
 to the Ledger API.
 Optional,
 Modifiable
      bool is_deactivated = 2 [json_name = "isDeactivated"];
      Returns:
      The isDeactivated.

    • getIssuer

      String getIssuer()
       Specifies the issuer of the JWT token.
 The issuer value is a case sensitive URL using the https scheme that contains scheme, host,
 and optionally, port number and path components and no query or fragment components.
 Required
 Modifiable
      string issuer = 3 [json_name = "issuer"];
      Returns:
      The issuer.

    • getIssuerBytes

      com.google.protobuf.ByteString getIssuerBytes()
       Specifies the issuer of the JWT token.
 The issuer value is a case sensitive URL using the https scheme that contains scheme, host,
 and optionally, port number and path components and no query or fragment components.
 Required
 Modifiable
      string issuer = 3 [json_name = "issuer"];
      Returns:
      The bytes for issuer.

    • getJwksUrl

      String getJwksUrl()
       The JWKS (JSON Web Key Set) URL.
 The Ledger API uses JWKs (JSON Web Keys) from the provided URL to verify that the JWT has been
 signed with the loaded JWK. Only RS256 (RSA Signature with SHA-256) signing algorithm is supported.
 Required
 Modifiable
      string jwks_url = 4 [json_name = "jwksUrl"];
      Returns:
      The jwksUrl.

    • getJwksUrlBytes

      com.google.protobuf.ByteString getJwksUrlBytes()
       The JWKS (JSON Web Key Set) URL.
 The Ledger API uses JWKs (JSON Web Keys) from the provided URL to verify that the JWT has been
 signed with the loaded JWK. Only RS256 (RSA Signature with SHA-256) signing algorithm is supported.
 Required
 Modifiable
      string jwks_url = 4 [json_name = "jwksUrl"];
      Returns:
      The bytes for jwksUrl.

    • getAudience

      String getAudience()
       Specifies the audience of the JWT token.
 When set, the callers using JWT tokens issued by this identity provider are allowed to get an access
 only if the "aud" claim includes the string specified here
 Optional,
 Modifiable
      string audience = 5 [json_name = "audience"];
      Returns:
      The audience.

    • getAudienceBytes

      com.google.protobuf.ByteString getAudienceBytes()
       Specifies the audience of the JWT token.
 When set, the callers using JWT tokens issued by this identity provider are allowed to get an access
 only if the "aud" claim includes the string specified here
 Optional,
 Modifiable
      string audience = 5 [json_name = "audience"];
      Returns:
      The bytes for audience.