DocumentationAPI reference

Rust · 0.1.0

SignInRequest

Exactly one supported credential alternative is sent for a sign-in attempt.

Credential alternatives

Choose passwordCredentials or ssoCredentials. They belong to a protobuf oneof even though this generated schema displays both properties without a oneOf constraint. Do not send both in the same JSON object.

Where this schema is used

These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.

Shape and fields

object

FieldType / requirementDescription
passwordCredentialsallOf
SignInRequest_PasswordCredentials
Username and password authentication.
ssoCredentialsallOf
SignInRequest_SSOCredentials
SSO provider authentication.

Complete schema

Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.

{
  "type": "object",
  "properties": {
    "passwordCredentials": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SignInRequest_PasswordCredentials"
        }
      ],
      "description": "Username and password authentication."
    },
    "ssoCredentials": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SignInRequest_SSOCredentials"
        }
      ],
      "description": "SSO provider authentication."
    }
  }
}