iam.users.create-login-profile

Give an IAM user a console password

POST /iam/api/users/{id}/login-profileIAM iam:CreateLoginProfileChanges state

The user signs in at /login/<org alias> with the user name and this password. Pass `password` (checked against the password policy) or `generatePassword: true`; a generated one is returned once in `generatedPassword`. Users of type `user` only.

Request syntax

POST /iam/api/users/{id}/login-profile
{
  "password": "string",
  "generatePassword": "boolean",
  "passwordResetRequired": "boolean"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

Request body

  • passwordOptional

    string

    The password to set, checked against the organization's password policy; leave out with generatePassword

    Constraints: 1-256 chars

  • generatePasswordOptional

    boolean

    true: a password that meets the policy is made for you and returned once, in generatedPassword

  • passwordResetRequiredOptional

    boolean

    The user must choose a new password at the first sign-in; default true

    Default: true

Response

201 with the console access as get-login-profile shows it, plus generatedPassword: the password made for you, shown only this once (null when you gave one).

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow iam:CreateLoginProfile on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud iam users create-login-profile id

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_iam_users_create-login-profile.