DocumentationAPI reference

Rust · 0.1.0

SignInRequest_SSOCredentials

Application protocol schema. Field names and inherited descriptions are kept in their original language.

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.

Referenced by these component schemas:

Shape and fields

object

Nested message for SSO authentication credentials.

FieldType / requirementDescription
idpNamestring
Required
The resource name of the SSO provider. Format: identity-providers/{idp}
codestring
Required
The authorization code from the SSO provider.
redirectUristring
Required
The redirect URI used in the SSO flow.
codeVerifierstringThe PKCE code verifier for enhanced security (RFC 7636). Optional - enables PKCE flow protection against authorization code interception.

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.

{
  "required": [
    "idpName",
    "code",
    "redirectUri"
  ],
  "type": "object",
  "properties": {
    "idpName": {
      "type": "string",
      "description": "The resource name of the SSO provider.\n Format: identity-providers/{idp}"
    },
    "code": {
      "type": "string",
      "description": "The authorization code from the SSO provider."
    },
    "redirectUri": {
      "type": "string",
      "description": "The redirect URI used in the SSO flow."
    },
    "codeVerifier": {
      "type": "string",
      "description": "The PKCE code verifier for enhanced security (RFC 7636).\n Optional - enables PKCE flow protection against authorization code interception."
    }
  },
  "description": "Nested message for SSO authentication credentials."
}