Headers

• Connect-Protocol-Version number Required

  Define the version of the Connect protocol

  Value is 1.

• Connect-Timeout-Ms number

  Define the timeout, in ms

Responses

• 200 application/json

  Success

  Hide response attribute Show response attribute object

  • roles array[object]

    The list of Roles.

    The Role resource represents a security role with associated members.

    Hide roles attributes Show roles attributes object

    • members array[object]

      The members of the Role.

      RoleMember represents a member of a Role.

      RoleMember represents a member of a Role.

      One of:

      group object user object

      Hide attribute Show attribute

      • group object Required

        RoleGroup represents a group member of a Role.

        Additional properties are NOT allowed.

        Hide group attribute Show group attribute object

        • name string

          The name of the group.

      Hide attribute Show attribute

      • user object Required

        RoleUser represents a user member of a Role.

        Additional properties are NOT allowed.

        Hide user attribute Show user attribute object

        • name string

          The name of the user.

    • name string Required

      (IMMUTABLE) The name of the Role.

• default application/json

  Error

  Hide response attributes Show response attributes object

  • code string

    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    Values are canceled, unknown, invalid_argument, deadline_exceeded, not_found, already_exists, permission_denied, resource_exhausted, failed_precondition, aborted, out_of_range, unimplemented, internal, unavailable, data_loss, or unauthenticated.

  • details array[object]

    A list of messages that carry the error details. There is no limit on the number of messages.

    Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.

    Hide details attributes Show details attributes object

    • debug object

      Detailed error information.

      Additional properties are allowed.

    • type string

      A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.

    • value string(binary)

      The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.

  • message string

    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.