openapi: 3.0.0
info:
version: 2015-07-09
x-release: v4
title: 'APIs.io Engineering Platform Amazon API Gateway 2014 11 13 #Action=GetAccountPasswordPolicy API'
description:
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#Action=GetAccountPasswordPolicy' paths: /#Action=GetAccountPasswordPolicy: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: x-aws-operation-name: GetAccountPasswordPolicy operationId: GET_GetAccountPasswordPolicy 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' '480': description: NoSuchEntityException content: text/xml: schema: $ref: '#/components/schemas/NoSuchEntityException' '481': description: ServiceFailureException content: text/xml: schema: $ref: '#/components/schemas/ServiceFailureException' parameters: - name: Action in: query required: true schema: type: string enum: - GetAccountPasswordPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 tags: - '#Action=GetAccountPasswordPolicy' post: x-aws-operation-name: GetAccountPasswordPolicy operationId: POST_GetAccountPasswordPolicy 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' '480': description: NoSuchEntityException content: text/xml: schema: $ref: '#/components/schemas/NoSuchEntityException' '481': description: ServiceFailureException content: text/xml: schema: $ref: '#/components/schemas/ServiceFailureException' parameters: - name: Action in: query required: true schema: type: string enum: - GetAccountPasswordPolicy - name: Version in: query required: true schema: type: string enum: - 2010-05-08 tags: - '#Action=GetAccountPasswordPolicy' components: parameters: X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false schemas: GetAccountPasswordPolicyResponse: type: object required: - PasswordPolicy example: PasswordPolicy: AllowUsersToChangePassword: false ExpirePasswords: false HardExpiry: false MaxPasswordAge: 90 MinimumPasswordLength: 8 PasswordReusePrevention: 12 RequireLowercaseCharacters: false RequireNumbers: true RequireSymbols: true RequireUppercaseCharacters: false properties: PasswordPolicy: allOf: - $ref: '#/components/schemas/PasswordPolicy' - description: A structure that contains details about the account's password policy. description: 'Contains the response to a successful GetAccountPasswordPolicy request. ' passwordReusePreventionType: type: integer minimum: 1 maximum: 24 NoSuchEntityException: {} minimumPasswordLengthType: type: integer minimum: 6 maximum: 128 booleanObjectType: type: boolean booleanType: type: boolean maxPasswordAgeType: type: integer minimum: 1 maximum: 1095 ServiceFailureException: {} PasswordPolicy: type: object properties: MinimumPasswordLength: allOf: - $ref: '#/components/schemas/minimumPasswordLengthType' - description: Minimum length to require for IAM user passwords. RequireSymbols: allOf: - $ref: '#/components/schemas/booleanType' - description: 'Specifies whether IAM user passwords must contain at least one of the following symbols:
! @ # $ % ^ & * ( ) _ + - = [ ] { } | ''
' RequireNumbers: allOf: - $ref: '#/components/schemas/booleanType' - description: Specifies whether IAM user passwords must contain at least one numeric character (0 to 9). RequireUppercaseCharacters: allOf: - $ref: '#/components/schemas/booleanType' - description: Specifies whether IAM user passwords must contain at least one uppercase character (A to Z). RequireLowercaseCharacters: allOf: - $ref: '#/components/schemas/booleanType' - description: Specifies whether IAM user passwords must contain at least one lowercase character (a to z). AllowUsersToChangePassword: allOf: - $ref: '#/components/schemas/booleanType' - description: Specifies whether IAM users are allowed to change their own password. Gives IAM users permissions toiam: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:
allOf:
- $ref: '#/components/schemas/booleanType'
- 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:
allOf:
- $ref: '#/components/schemas/maxPasswordAgeType'
- description: The number of days that an IAM user password is valid.
PasswordReusePrevention:
allOf:
- $ref: '#/components/schemas/passwordReusePreventionType'
- description: Specifies the number of previous passwords that IAM users are prevented from reusing.
HardExpiry:
allOf:
- $ref: '#/components/schemas/booleanObjectType'
- 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.
description: Contains information about the account password policy.
This data type is used as a response element in the GetAccountPasswordPolicy operation.
securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true