Interface CredentialsAuthRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CredentialsAuthRequest, CredentialsAuthRequest.Builder
@Generated public interface CredentialsAuthRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getInstanceId()
    The UUID of the SoulFire instance to authenticate accounts for.
    com.google.protobuf.ByteString
    getInstanceIdBytes()
    The UUID of the SoulFire instance to authenticate accounts for.
    String
    getPayload(int index)
    List of authentication credentials/data strings.
    com.google.protobuf.ByteString
    getPayloadBytes(int index)
    List of authentication credentials/data strings.
    int
    getPayloadCount()
    List of authentication credentials/data strings.
    List<String>
    getPayloadList()
    List of authentication credentials/data strings.
    AccountTypeCredentials
    getService()
    The authentication service type to use.
    int
    getServiceValue()
    The authentication service type to use.

    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

    • getInstanceId

      String getInstanceId()
      The UUID of the SoulFire instance to authenticate accounts for.
Must be a valid UUID string. The instance must exist and the caller
must have AUTHENTICATE_MC_ACCOUNT permission for this instance.
      string instance_id = 1;
      Returns:
      The instanceId.

    • getInstanceIdBytes

      com.google.protobuf.ByteString getInstanceIdBytes()
      The UUID of the SoulFire instance to authenticate accounts for.
Must be a valid UUID string. The instance must exist and the caller
must have AUTHENTICATE_MC_ACCOUNT permission for this instance.
      string instance_id = 1;
      Returns:
      The bytes for instanceId.

    • getServiceValue

      int getServiceValue()
      The authentication service type to use.
Determines how the payload strings are interpreted:
- MICROSOFT_JAVA_CREDENTIALS: Payload format is "email:password"
- MICROSOFT_BEDROCK_CREDENTIALS: Payload format is "email:password"
- OFFLINE: Payload is the username to use (no authentication performed)
- MICROSOFT_JAVA_REFRESH_TOKEN: Payload is a Microsoft refresh token
      .soulfire.v1.AccountTypeCredentials service = 2;
      Returns:
      The enum numeric value on the wire for service.

    • getService

      AccountTypeCredentials getService()
      The authentication service type to use.
Determines how the payload strings are interpreted:
- MICROSOFT_JAVA_CREDENTIALS: Payload format is "email:password"
- MICROSOFT_BEDROCK_CREDENTIALS: Payload format is "email:password"
- OFFLINE: Payload is the username to use (no authentication performed)
- MICROSOFT_JAVA_REFRESH_TOKEN: Payload is a Microsoft refresh token
      .soulfire.v1.AccountTypeCredentials service = 2;
      Returns:
      The service.

    • getPayloadList

      List<String> getPayloadList()
      List of authentication credentials/data strings.
Each string is processed according to the service type.
Multiple payloads are authenticated concurrently (controlled by
ACCOUNT_IMPORT_CONCURRENCY instance setting).
      repeated string payload = 3;
      Returns:
      A list containing the payload.

    • getPayloadCount

      int getPayloadCount()
      List of authentication credentials/data strings.
Each string is processed according to the service type.
Multiple payloads are authenticated concurrently (controlled by
ACCOUNT_IMPORT_CONCURRENCY instance setting).
      repeated string payload = 3;
      Returns:
      The count of payload.

    • getPayload

      String getPayload(int index)
      List of authentication credentials/data strings.
Each string is processed according to the service type.
Multiple payloads are authenticated concurrently (controlled by
ACCOUNT_IMPORT_CONCURRENCY instance setting).
      repeated string payload = 3;
      Parameters:
      index - The index of the element to return.
      Returns:
      The payload at the given index.

    • getPayloadBytes

      com.google.protobuf.ByteString getPayloadBytes(int index)
      List of authentication credentials/data strings.
Each string is processed according to the service type.
Multiple payloads are authenticated concurrently (controlled by
ACCOUNT_IMPORT_CONCURRENCY instance setting).
      repeated string payload = 3;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the payload at the given index.