Package com.daml.ledger.api.v1.admin

Interface UserManagementServiceOuterClass.UserOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getId()
      The user identifier, which must be a non-empty string of at most 128 characters that are either alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:".
      com.google.protobuf.ByteString getIdBytes()
      The user identifier, which must be a non-empty string of at most 128 characters that are either alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:".
      java.lang.String getIdentityProviderId()
      The id of the identity provider configured by ``Identity Provider Config`` Optional, if not set, assume the user is managed by the default identity provider.
      com.google.protobuf.ByteString getIdentityProviderIdBytes()
      The id of the identity provider configured by ``Identity Provider Config`` Optional, if not set, assume the user is managed by the default identity provider.
      boolean getIsDeactivated()
      When set, then the user is denied all access to the Ledger API.
      ObjectMetaOuterClass.ObjectMeta getMetadata()
      The metadata of this user.
      ObjectMetaOuterClass.ObjectMetaOrBuilder getMetadataOrBuilder()
      The metadata of this user.
      java.lang.String getPrimaryParty()
      The primary party as which this user reads and acts by default on the ledger *provided* it has the corresponding ``CanReadAs(primary_party)`` or ``CanActAs(primary_party)`` rights.
      com.google.protobuf.ByteString getPrimaryPartyBytes()
      The primary party as which this user reads and acts by default on the ledger *provided* it has the corresponding ``CanReadAs(primary_party)`` or ``CanActAs(primary_party)`` rights.
      boolean hasMetadata()
      The metadata of this user.

      • 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 Detail

      • getId

        java.lang.String getId()
         The user identifier, which must be a non-empty string of at most 128
 characters that are either alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:".
 Required
        string id = 1 [json_name = "id"];
        Returns:
        The id.

      • getIdBytes

        com.google.protobuf.ByteString getIdBytes()
         The user identifier, which must be a non-empty string of at most 128
 characters that are either alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:".
 Required
        string id = 1 [json_name = "id"];
        Returns:
        The bytes for id.

      • getPrimaryParty

        java.lang.String getPrimaryParty()
         The primary party as which this user reads and acts by default on the ledger
 *provided* it has the corresponding ``CanReadAs(primary_party)`` or
 ``CanActAs(primary_party)`` rights.
 Ledger API clients SHOULD set this field to a non-empty value for all users to
 enable the users to act on the ledger using their own Daml party.
 Users for participant administrators MAY have an associated primary party.
 Optional,
 Modifiable
        string primary_party = 2 [json_name = "primaryParty"];
        Returns:
        The primaryParty.

      • getPrimaryPartyBytes

        com.google.protobuf.ByteString getPrimaryPartyBytes()
         The primary party as which this user reads and acts by default on the ledger
 *provided* it has the corresponding ``CanReadAs(primary_party)`` or
 ``CanActAs(primary_party)`` rights.
 Ledger API clients SHOULD set this field to a non-empty value for all users to
 enable the users to act on the ledger using their own Daml party.
 Users for participant administrators MAY have an associated primary party.
 Optional,
 Modifiable
        string primary_party = 2 [json_name = "primaryParty"];
        Returns:
        The bytes for primaryParty.

      • getIsDeactivated

        boolean getIsDeactivated()
         When set, then the user is denied all access to the Ledger API.
 Otherwise, the user has access to the Ledger API as per the user's rights.
 Optional,
 Modifiable
        bool is_deactivated = 3 [json_name = "isDeactivated"];
        Returns:
        The isDeactivated.

      • hasMetadata

        boolean hasMetadata()
         The metadata of this user.
 Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights.
 Optional,
 Modifiable
        .com.daml.ledger.api.v1.admin.ObjectMeta metadata = 4 [json_name = "metadata"];
        Returns:
        Whether the metadata field is set.

      • getMetadata

        ObjectMetaOuterClass.ObjectMeta getMetadata()
         The metadata of this user.
 Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights.
 Optional,
 Modifiable
        .com.daml.ledger.api.v1.admin.ObjectMeta metadata = 4 [json_name = "metadata"];
        Returns:
        The metadata.

      • getMetadataOrBuilder

        ObjectMetaOuterClass.ObjectMetaOrBuilder getMetadataOrBuilder()
         The metadata of this user.
 Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights.
 Optional,
 Modifiable
        .com.daml.ledger.api.v1.admin.ObjectMeta metadata = 4 [json_name = "metadata"];

      • getIdentityProviderId

        java.lang.String getIdentityProviderId()
         The id of the identity provider configured by ``Identity Provider Config``
 Optional, if not set, assume the user is managed by the default identity provider.
        string identity_provider_id = 5 [json_name = "identityProviderId"];
        Returns:
        The identityProviderId.

      • getIdentityProviderIdBytes

        com.google.protobuf.ByteString getIdentityProviderIdBytes()
         The id of the identity provider configured by ``Identity Provider Config``
 Optional, if not set, assume the user is managed by the default identity provider.
        string identity_provider_id = 5 [json_name = "identityProviderId"];
        Returns:
        The bytes for identityProviderId.