Saltar al contenido principal
DocumentaciónIdentidad y acceso · console.latam.ccsio.ai

Self password

The signed-in person's own password: how it is managed, a change with the current password as proof, and a reset email. A person only: an API key cannot use them.

Menú de la documentación

Las descripciones de las operaciones y los campos son las del contrato, en inglés.

GET/identity/v1/self/password

Read how the signed-in person's password is managed

Credencial
El token de una persona con sesión iniciada (consola)
Permiso
Ninguno además de la credencial

Requires a verified human OIDC session of this plane's identity provider and no organization: an API key, a personal key, the bootstrap credential, a platform operator's staff session and a token of another issuer are 403 policy-denied.

Leer más

The user is always the verified principal's; the body never names one. core relays the passwords to the identity provider in memory and never stores, logs, traces or counts them. Answers what the person may do with their password: management is local (the person holds a password here, and may change it and ask for a reset email), identity_provider (the person signs in through an identity provider that holds the password; identity_providers names it and, when known, management_url is the provider's own page for changing it), disabled_by_organization (the organization's login policy turns password sign-in off) or not_set (no password is set on the account). can_change and can_reset are true only for local. policy, the password rules that apply to the person's organization, is present only for local; last_changed_at is absent when the identity provider has no password change on record. The answer carries no password and no hint of one. Never cached (Cache-Control: no-store). Budget per person and per client address (429 rate-limited, with Retry-After).

curl
curl "https://console.latam.ccsio.ai/identity/v1/self/password" \
  -H "Authorization: Bearer $CCSIO_ACCESS_TOKEN"

Parámetros

NombreEnDescripción
X-Request-ID
opcional
headerstring

Optional request ULID. A valid ULID (upper or lowercase) is honored; when the header is absent or invalid, the runtime mints the id. The response X-Request-ID header carries the canonical uppercase form.

Respuestas

  • 200

    How the person's password is managed.

    Esquema
    SelfPasswordStatus
    • managementstringobligatorio

      Who holds the person's password: local (the identity provider of this plane, and the person may change it), identity_provider (an identity provider the person signs in through), disabled_by_organization (the organization's login policy turns password sign-in off) or not_set (no password is set on the account).

      Valores permitidos: "local""identity_provider""disabled_by_organization""not_set"

    • can_changebooleanobligatorio

      True only for management local.

    • can_resetbooleanobligatorio

      True only for management local.

    • last_changed_atstring (date-time)opcional

      RFC 3339, UTC. Absent when the identity provider has no password change on record.

    • change_requiredbooleanobligatorio

      The identity provider requires the person to set a new password.

    • policyobjectopcional

      Present only for management local.

      • min_lengthintegerobligatorio

        at least 1

      • max_lengthintegerobligatorio

        at least 1

      • requires_uppercasebooleanobligatorio
      • requires_lowercasebooleanobligatorio
      • requires_numberbooleanobligatorio
      • requires_symbolbooleanobligatorio
    • identity_providersarray of SelfPasswordIdentityProviderobligatorio

      Empty unless management is identity_provider.

      • namestringobligatorio

        The connection's display name, or 'your identity provider' when the link matches no connection of the platform.

      • kindstringopcional

        Absent when the link matches no connection of the platform.

        Valores permitidos: "entra""oidc"

      • management_urlstring (uri)opcional

        The provider's own page for changing a password. Present only for Microsoft Entra ID (mysignins.microsoft.com) and for an OIDC connection whose issuer is accounts.google.com (myaccount.google.com).

        pattern ^https://

  • 401

    The request carries no credential, more than one, or one the platform does not accept, and is refused before the operation runs; `error.code` says why. Supply exactly one credential. Codes: invalid-request (no credential, or both Authorization:

    Leer más

    Bearer and x-api-key), api-key-invalid (a value that is not a platform API key, or a key of a kind the platform does not accept), api-key-unknown, api-key-revoked, api-key-expired, bootstrap-disabled (the one-shot installation credential, once a key exists), token-malformed (a bearer token that is not a JWT), token-algorithm-unsupported, token-signature-invalid, token-claim-invalid, token-issuer-mismatch, token-audience-mismatch, token-expired, token-not-yet-valid, issuer-untrusted, issuer-residency-mismatch (the issuer belongs to another plane), issuer-resolution-unknown, jwks-unavailable, jwks-key-not-found, staff-token-inactive (a platform operator's token), staff-not-operator, staff-directory-unavailable, identity-not-provisioned (a verified identity with no account on this plane), organization-not-found (a verified identity or key whose organization this plane does not know), internal-error (a fault while the credential is checked is refused too, fail closed), context-cancelled

  • 403

    Codes: policy-denied (not a person's session of this plane's identity provider), user-disabled

  • 405

    The path is claimed but the request method is not allowed. Go ServeMux returns its standard plain-text response and lists permitted methods in Allow.

  • 429

    The status budget of the person or of the client address is used up. Codes: rate-limited

  • 500

    Platform failure, rendered without internal cause details.

  • 503

    The identity provider could not be reached or does not confirm the user, or the plane has none. Codes: organization-identity-unavailable, onboarding-unavailable

Respuesta de ejemplo
{
  "management": "local",
  "can_change": true,
  "can_reset": true,
  "last_changed_at": "2026-09-30T08:12:44Z",
  "change_required": false,
  "policy": {
    "min_length": 8,
    "max_length": 72,
    "requires_uppercase": true,
    "requires_lowercase": true,
    "requires_number": true,
    "requires_symbol": true
  },
  "identity_providers": []
}
POST/identity/v1/self/password/change

Change the signed-in person's password

Credencial
El token de una persona con sesión iniciada (consola)
Permiso
Ninguno además de la credencial
Cuerpo de la solicitud
Cuerpo de hasta 8192 bytes

Requires a verified human OIDC session of this plane's identity provider and no organization: an API key, a personal key, the bootstrap credential, a platform operator's staff session and a token of another issuer are 403 policy-denied.

Leer más

The user is always the verified principal's; the body never names one. core relays the passwords to the identity provider in memory and never stores, logs, traces or counts them. The proof of the change is the current password, which the identity provider verifies: the three members are all required, strict JSON of at most 8 KiB, 1 to 200 characters each. core first checks that new_password and new_password_confirmation are equal, that the new password differs from the current one and that it meets the password policy and the 72-byte limit, so a wrong current password counts as one failed attempt at the identity provider only when the candidate is valid. An account that holds no local password (an identity provider, a login policy that turns passwords off, no password set) is 409 password-change-unavailable even when called directly. The change does not end the person's other sessions. Budget per person (burst 5, 6 per hour) and per client address (429 rate-limited, with Retry-After); a request refused by validation or by the budget writes no security event. Records user.password.change.requested, then user.password.change.completed or user.password.change.failed, in each organization the person is an active member of. The answer carries no password.

curl
curl -X POST "https://console.latam.ccsio.ai/identity/v1/self/password/change" \
  -H "Authorization: Bearer $CCSIO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "current_password": "string",
  "new_password": "string",
  "new_password_confirmation": "string"
}'
Construido con los campos obligatorios del esquema: reemplaza los valores.

Parámetros

NombreEnDescripción
X-Request-ID
opcional
headerstring

Optional request ULID. A valid ULID (upper or lowercase) is honored; when the header is absent or invalid, the runtime mints the id. The response X-Request-ID header carries the canonical uppercase form.

Cuerpo de la solicitud application/json

ChangePasswordRequest
  • current_passwordstring (password)obligatorio

    The password the person signs in with now; the identity provider verifies it.

    1 to 200 characters

  • new_passwordstring (password)obligatorio

    The new password; it must differ from the current one and meet the password policy.

    1 to 200 characters

  • new_password_confirmationstring (password)obligatorio

    The new password again; it must equal new_password.

    1 to 200 characters

Respuestas

  • 200

    The password was changed.

    Esquema
    ChangePasswordResponse
    • changed_atstring (date-time)obligatorio

      RFC 3339, UTC: when the identity provider recorded the change.

  • 400

    Client refusal.

    Leer más

    Codes: invalid-request (the body is not valid JSON, has an unknown or repeated member, lacks one of the three members, or one is outside 1 to 200 characters), password-confirmation-mismatch (new_password and new_password_confirmation differ), password-policy-violation (the new password breaks the password policy or is over 72 bytes; the fixed message names the rules that failed, never the password), password-unchanged (the new password equals the current one), current-password-incorrect (the identity provider does not accept the current password)

  • 401

    The request carries no credential, more than one, or one the platform does not accept, and is refused before the operation runs; `error.code` says why. Supply exactly one credential. Codes: invalid-request (no credential, or both Authorization:

    Leer más

    Bearer and x-api-key), api-key-invalid (a value that is not a platform API key, or a key of a kind the platform does not accept), api-key-unknown, api-key-revoked, api-key-expired, bootstrap-disabled (the one-shot installation credential, once a key exists), token-malformed (a bearer token that is not a JWT), token-algorithm-unsupported, token-signature-invalid, token-claim-invalid, token-issuer-mismatch, token-audience-mismatch, token-expired, token-not-yet-valid, issuer-untrusted, issuer-residency-mismatch (the issuer belongs to another plane), issuer-resolution-unknown, jwks-unavailable, jwks-key-not-found, staff-token-inactive (a platform operator's token), staff-not-operator, staff-directory-unavailable, identity-not-provisioned (a verified identity with no account on this plane), organization-not-found (a verified identity or key whose organization this plane does not know), internal-error (a fault while the credential is checked is refused too, fail closed), context-cancelled

  • 403

    Codes: policy-denied (not a person's session of this plane's identity provider), user-disabled

  • 405

    The path is claimed but the request method is not allowed. Go ServeMux returns its standard plain-text response and lists permitted methods in Allow.

  • 409

    The account cannot have its password changed here. Codes: password-change-unavailable (the account holds no local password, or the organization turns password sign-in off), account-locked (the identity provider locked the account)

  • 413

    The request is over 8 KiB. Codes: request-body-too-large

  • 429

    The change budget of the person or of the client address is used up. Codes: rate-limited

  • 500

    Platform failure, rendered without internal cause details.

  • 503

    The identity provider could not be reached or does not confirm the user, or the plane has none. Codes: organization-identity-unavailable, onboarding-unavailable

Respuesta de ejemplo
{
  "changed_at": "2026-11-09T10:15:30Z"
}
POST/identity/v1/self/password/reset

Email the signed-in person a link to set a new password

Credencial
El token de una persona con sesión iniciada (consola)
Permiso
Ninguno además de la credencial
Cuerpo de la solicitud
Cuerpo de hasta 8192 bytes

Requires a verified human OIDC session of this plane's identity provider and no organization: an API key, a personal key, the bootstrap credential, a platform operator's staff session and a token of another issuer are 403 policy-denied.

Leer más

The user is always the verified principal's; the body never names one. core relays the passwords to the identity provider in memory and never stores, logs, traces or counts them. Asks the identity provider to email the person a link to set a new password; the link leads to the identity provider's own page, so core never sees, mints or stores a code or a password, and the answer does not say whether the person follows the link. The body is exactly {} (strict JSON of at most 8 KiB). Answers 202 with sent true once the identity provider has accepted the request. An account that holds no local password is 409 password-reset-unavailable even when called directly. Budget per person (burst 2, 3 per hour, at least 60 seconds between two sends) and per client address (429 rate-limited, with Retry-After). Records user.password.reset.requested (success or failure) in each organization the person is an active member of; user.password.reset.completed is recorded when core next sees a password change later than the request (the person's next sign-in or visit to GET /identity/v1/self/password), once per request.

curl
curl -X POST "https://console.latam.ccsio.ai/identity/v1/self/password/reset" \
  -H "Authorization: Bearer $CCSIO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Parámetros

NombreEnDescripción
X-Request-ID
opcional
headerstring

Optional request ULID. A valid ULID (upper or lowercase) is honored; when the header is absent or invalid, the runtime mints the id. The response X-Request-ID header carries the canonical uppercase form.

Cuerpo de la solicitud application/json

ResetPasswordRequest

Takes no member: the person is the caller.

Respuestas

  • 202

    The identity provider was asked to send the email.

    Esquema
    ResetPasswordResponse
    • sentbooleanobligatorio

      The identity provider accepted the request to send the email.

      always true

  • 400

    Client refusal. Codes: invalid-request (the body is not valid JSON or names a member)

  • 401

    The request carries no credential, more than one, or one the platform does not accept, and is refused before the operation runs; `error.code` says why. Supply exactly one credential. Codes: invalid-request (no credential, or both Authorization:

    Leer más

    Bearer and x-api-key), api-key-invalid (a value that is not a platform API key, or a key of a kind the platform does not accept), api-key-unknown, api-key-revoked, api-key-expired, bootstrap-disabled (the one-shot installation credential, once a key exists), token-malformed (a bearer token that is not a JWT), token-algorithm-unsupported, token-signature-invalid, token-claim-invalid, token-issuer-mismatch, token-audience-mismatch, token-expired, token-not-yet-valid, issuer-untrusted, issuer-residency-mismatch (the issuer belongs to another plane), issuer-resolution-unknown, jwks-unavailable, jwks-key-not-found, staff-token-inactive (a platform operator's token), staff-not-operator, staff-directory-unavailable, identity-not-provisioned (a verified identity with no account on this plane), organization-not-found (a verified identity or key whose organization this plane does not know), internal-error (a fault while the credential is checked is refused too, fail closed), context-cancelled

  • 403

    Codes: policy-denied (not a person's session of this plane's identity provider), user-disabled

  • 405

    The path is claimed but the request method is not allowed. Go ServeMux returns its standard plain-text response and lists permitted methods in Allow.

  • 409

    The identity provider has nothing to send for this account. Codes: password-reset-unavailable (the account holds no local password, or the organization turns password sign-in off)

  • 413

    The request is over 8 KiB. Codes: request-body-too-large

  • 429

    The reset budget of the person or of the client address is used up. Codes: rate-limited

  • 500

    Platform failure, rendered without internal cause details.

  • 503

    The identity provider could not be reached or does not confirm the user, or the plane has none. Codes: organization-identity-unavailable, onboarding-unavailable

Respuesta de ejemplo
{
  "sent": true
}

Generado a partir de los contratos de la plataforma en el commit 5954fbc1.

Explora la plataforma

Obtén tu primera key API

El registro está abierto. Cuatro pasos hasta tu primera llamada: crea tu cuenta, crea tu organización, crea tu API key y empieza a usarla.

  1. 01Crea tu cuenta
  2. 02Crea tu organización
  3. 03Crea tu API key
  4. 04Empieza a usarla