Amazon IAM Iam Account Password Policy API

openapi: 3.2.0
info:
  title: AWS Identity and Access Management Account Password Policy…
  version: '2010-05-08'
  description: Generated from AWS's published Smithy model for AWS Identity and Access Management. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://iam.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Account Password Policy
paths:
  /?Action=DeleteAccountPasswordPolicy:
    post:
      operationId: DeleteAccountPasswordPolicy
      summary: Delete Account Password Policy
      description: Deletes the password policy for the Amazon Web Services account. There are no parameters.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '409':
          description: LimitExceededException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NoSuchEntityException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchEntityException'
        '500':
          description: ServiceFailureException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ServiceFailureException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteAccountPasswordPolicy
                  Version:
                    type: string
                    const: '2010-05-08'
              - type: string
      tags:
      - Account Password Policy
  /?Action=GetAccountPasswordPolicy:
    post:
      operationId: GetAccountPasswordPolicy
      summary: Get Account Password Policy
      description: Retrieves the password policy for the Amazon Web Services account. This tells you the complexity requirements and mandatory rotation periods for the IAM user passwords in your account. For more information about using a password policy, see Managing an IAM password policy.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetAccountPasswordPolicyResponse'
              example:
                PasswordPolicy:
                  AllowUsersToChangePassword: false
                  RequireNumbers: true
                  RequireLowercaseCharacters: false
                  RequireUppercaseCharacters: false
                  MinimumPasswordLength: 8
                  RequireSymbols: true
                  ExpirePasswords: false
                  PasswordReusePrevention: 12
                  MaxPasswordAge: 90
                  HardExpiry: false
        '404':
          description: NoSuchEntityException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchEntityException'
        '500':
          description: ServiceFailureException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ServiceFailureException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: GetAccountPasswordPolicy
                  Version:
                    type: string
                    const: '2010-05-08'
              - type: string
      tags:
      - Account Password Policy
  /?Action=UpdateAccountPasswordPolicy:
    post:
      operationId: UpdateAccountPasswordPolicy
      summary: Update Account Password Policy
      description: Updates the password policy settings for the Amazon Web Services account. This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation. For more information about using a password policy, see Managing an IAM password policy in the IAM User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '409':
          description: LimitExceededException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '400':
          description: MalformedPolicyDocumentException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/MalformedPolicyDocumentException'
        '404':
          description: NoSuchEntityException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchEntityException'
        '500':
          description: ServiceFailureException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ServiceFailureException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: UpdateAccountPasswordPolicy
                  Version:
                    type: string
                    const: '2010-05-08'
              - $ref: '#/components/schemas/UpdateAccountPasswordPolicyRequest'
            example:
              MinimumPasswordLength: 8
              RequireNumbers: true
      tags:
      - Account Password Policy
components:
  schemas:
    MalformedPolicyDocumentException:
      type: object
      properties:
        message:
          type: string
    NoSuchEntityException:
      type: object
      properties:
        message:
          type: string
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
    PasswordPolicy:
      type: object
      properties:
        MinimumPasswordLength:
          type: integer
          description: Minimum length to require for IAM user passwords.
        RequireSymbols:
          type: boolean
          description: 'Specifies whether IAM user passwords must contain at least one of the following symbols: ! @ # $ % ^ & * ( ) _ + - = [ ] { } | '''
        RequireNumbers:
          type: boolean
          description: Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).
        RequireUppercaseCharacters:
          type: boolean
          description: Specifies whether IAM user passwords must contain at least one uppercase character (A to Z).
        RequireLowercaseCharacters:
          type: boolean
          description: Specifies whether IAM user passwords must contain at least one lowercase character (a to z).
        AllowUsersToChangePassword:
          type: boolean
          description: Specifies whether IAM users are allowed to change their own password. Gives IAM users permissions to iam:ChangePassword for only their user and to the iam:GetAccountPasswordPolicy action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM.
        ExpirePasswords:
          type: boolean
          description: Indicates whether passwords in the account expire. Returns true if MaxPasswordAge contains a value greater than 0. Returns false if MaxPasswordAge is 0 or not present.
        MaxPasswordAge:
          type: integer
          description: The number of days that an IAM user password is valid.
        PasswordReusePrevention:
          type: integer
          description: Specifies the number of previous passwords that IAM users are prevented from reusing.
        HardExpiry:
          type: boolean
          description: Specifies whether IAM users are prevented from setting a new password via the Amazon Web Services Management Console after their password has expired. The IAM user cannot access the console until an administrator resets the password. IAM users with iam:ChangePassword permission and active access keys can reset their own expired console password using the CLI or API.
    GetAccountPasswordPolicyResponse:
      type: object
      properties:
        PasswordPolicy:
          $ref: '#/components/schemas/PasswordPolicy'
      required:
      - PasswordPolicy
    UpdateAccountPasswordPolicyRequest:
      type: object
      properties:
        MinimumPasswordLength:
          type: integer
          description: The minimum number of characters allowed in an IAM user password. If you do not specify a value for this parameter, then the operation uses the default value of 6.
        RequireSymbols:
          type: boolean
          description: 'Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters: ! @ # $ % ^ & * ( ) _ + - = [ ] { } | '' If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one symbol character.'
        RequireNumbers:
          type: boolean
          description: Specifies whether IAM user passwords must contain at least one numeric character (0 to 9). If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one numeric character.
        RequireUppercaseCharacters:
          type: boolean
          description: Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z). If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one uppercase character.
        RequireLowercaseCharacters:
          type: boolean
          description: Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z). If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one lowercase character.
        AllowUsersToChangePassword:
          type: boolean
          description: Allows all IAM users in your account to use the Amazon Web Services Management Console to change their own passwords. For more information, see Permitting IAM users to change their own passwords in the IAM User Guide. If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users in the account do not automatically have permissions to change their own password.
        MaxPasswordAge:
          type: integer
          description: The number of days that an IAM user password is valid. If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM user passwords never expire.
        PasswordReusePrevention:
          type: integer
          description: Specifies the number of previous passwords that IAM users are prevented from reusing. If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM users are not prevented from reusing previous passwords.
        HardExpiry:
          type: boolean
          description: 'Prevents IAM users who are accessing the account via the Amazon Web Services Management Console from setting a new console password after their password has expired. The IAM user cannot access the console until an administrator resets the password. If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users can change their passwords after they expire and continue to sign in as the user. In the Amazon Web Services Management Console, the custom password policy option Allow users to change their own password gives IAM users '
    ServiceFailureException:
      type: object
      properties:
        message:
          type: string
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: iam
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/iam/service/2010-05-08/iam-2010-05-08.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)