APIs.io Engineering Platform User's Account Memberships API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 User's Account Memberships API
  description: <fullname>Amazon API Gateway</fullname> <p>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.</p>
  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
    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: User's Account Memberships
paths:
  /memberships:
    get:
      description: List memberships of accounts the user can access.
      operationId: user'-s-account-memberships-list-memberships
      parameters:
      - in: query
        name: account.name
        schema:
          $ref: '#/components/schemas/iam_properties-name'
      - in: query
        name: page
        schema:
          default: 1
          description: Page number of paginated results.
          minimum: 1
          type: number
      - in: query
        name: per_page
        schema:
          default: 20
          description: Number of memberships per page.
          maximum: 50
          minimum: 5
          type: number
      - in: query
        name: order
        schema:
          description: Field to order memberships by.
          enum:
          - id
          - account.name
          - status
          example: status
          type: string
      - in: query
        name: direction
        schema:
          description: Direction to order memberships.
          enum:
          - asc
          - desc
          example: desc
          type: string
      - in: query
        name: name
        schema:
          $ref: '#/components/schemas/iam_properties-name'
      - in: query
        name: status
        schema:
          description: Status of this membership.
          enum:
          - accepted
          - pending
          - rejected
          example: accepted
          type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: List Memberships response failure
        '200':
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/iam_collection_membership_response'
                - $ref: '#/components/schemas/iam_collection_membership_response_with_policies'
          description: List Memberships response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Memberships
      tags:
      - User's Account Memberships
      x-api-token-group:
      - Memberships Write
      - Memberships Read
  /memberships/{membership_id}:
    delete:
      description: Remove the associated member from an account.
      operationId: user'-s-account-memberships-delete-membership
      parameters:
      - in: path
        name: membership_id
        required: true
        schema:
          $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Delete Membership response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/iam_api-response-single'
                - properties:
                    result:
                      properties:
                        id:
                          $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
                  type: object
          description: Delete Membership response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Membership
      tags:
      - User's Account Memberships
      x-api-token-group:
      - Memberships Write
    get:
      description: Get a specific membership.
      operationId: user'-s-account-memberships-membership-details
      parameters:
      - in: path
        name: membership_id
        required: true
        schema:
          $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Membership Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_membership_response_with_policies'
          description: Membership Details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Membership Details
      tags:
      - User's Account Memberships
      x-api-token-group:
      - Memberships Write
      - Memberships Read
    put:
      description: Accept or reject this account invitation.
      operationId: user'-s-account-memberships-update-membership
      parameters:
      - in: path
        name: membership_id
        required: true
        schema:
          $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                status:
                  description: Whether to accept or reject this account invitation.
                  enum:
                  - accepted
                  - rejected
                  example: accepted
              required:
              - status
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Update Membership response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_membership_response_with_policies'
          description: Update Membership response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update Membership
      tags:
      - User's Account Memberships
      x-api-token-group:
      - Memberships Write
components:
  schemas:
    iam_scope:
      description: A scope is a combination of scope objects which provides additional context.
      properties:
        key:
          $ref: '#/components/schemas/iam_scope_key'
        objects:
          description: A list of scope objects for additional context.
          items:
            $ref: '#/components/schemas/iam_scope_object'
          type: array
      required:
      - key
      - objects
      type: object
    iam_scope_key:
      description: This is a combination of pre-defined resource name and identifier (like Account ID etc.)
      example: com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4
      readOnly: true
    iam_permission_groups:
      description: A set of permission groups that are specified to the policy.
      example:
      - id: c8fed203ed3043cba015a93ad1616f1f
        meta:
          label: load_balancer_admin
          scopes: com.cloudflare.api.account
        name: Zone Read
      - id: 82e64a83756745bbbb1c9c2701bf816b
        meta:
          label: fbm_user
          scopes: com.cloudflare.api.account
        name: Magic Network Monitoring
      items:
        $ref: '#/components/schemas/iam_permission_group'
      type: array
    iam_identifier:
      description: Policy identifier.
      example: f267e341f3dd4697bd3b9f71dd96247f
      readOnly: true
      type: string
    iam_account:
      properties:
        created_on:
          description: Timestamp for the creation of the account
          example: '2014-03-01T12:21:02.0000Z'
          format: date-time
          readOnly: true
          type: string
        id:
          $ref: '#/components/schemas/iam_common_components-schemas-identifier'
        name:
          description: Account name
          example: Demo Account
          maxLength: 100
          type: string
        settings:
          description: Account settings
          properties:
            abuse_contact_email:
              description: Sets an abuse contact email to notify for abuse reports.
              type: string
            default_nameservers:
              default: cloudflare.standard
              description: 'Specifies the default nameservers to be used for new zones added to this account.


                - `cloudflare.standard` for Cloudflare-branded nameservers

                - `custom.account` for account custom nameservers

                - `custom.tenant` for tenant custom nameservers


                See [Custom Nameservers](https://developers.cloudflare.com/dns/additional-options/custom-nameservers/)

                for more information.'
              enum:
              - cloudflare.standard
              - custom.account
              - custom.tenant
              type: string
            enforce_twofactor:
              default: false
              description: 'Indicates whether membership in this account requires that

                Two-Factor Authentication is enabled'
              type: boolean
            use_account_custom_ns_by_default:
              default: false
              deprecated: true
              description: 'Indicates whether new zones should use the account-level custom

                nameservers by default.


                Deprecated in favor of `default_nameservers`.'
              type: boolean
          type: object
      required:
      - id
      - name
      type: object
    iam_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    iam_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/iam_messages'
        messages:
          $ref: '#/components/schemas/iam_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    iam_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/iam_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/iam_messages'
          example: []
        result:
          enum:
          - null
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    iam_scope_object_key:
      description: This is a combination of pre-defined resource name and identifier (like Zone ID etc.)
      example: com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5
      readOnly: true
    iam_api_access_enabled:
      description: Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.
      example: true
      nullable: true
      type: boolean
    iam_grants:
      example:
        read: true
        write: false
      properties:
        read:
          example: true
          type: boolean
        write:
          example: true
          type: boolean
      type: object
    iam_membership-with-policies:
      properties:
        account:
          $ref: '#/components/schemas/iam_schemas-account'
        api_access_enabled:
          $ref: '#/components/schemas/iam_api_access_enabled'
        id:
          $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
        permissions:
          allOf:
          - $ref: '#/components/schemas/iam_permissions'
          description: All access permissions for the user at the account.
          readOnly: true
        policies:
          description: Access policy for the membership
          items:
            $ref: '#/components/schemas/iam_list_member_policy'
          type: array
        roles:
          $ref: '#/components/schemas/iam_roles'
        status:
          $ref: '#/components/schemas/iam_schemas-status'
      type: object
    iam_common_components-schemas-identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    iam_membership_components-schemas-identifier:
      description: Membership identifier tag.
      example: 4536bcfad5faccb111b47003c79917fa
      maxLength: 32
      readOnly: true
      type: string
    iam_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-common'
      - properties:
          result:
            items: {}
            nullable: true
            type: array
          result_info:
            $ref: '#/components/schemas/iam_result_info'
      type: object
    iam_collection_membership_response_with_policies:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/iam_membership-with-policies'
            type: array
        type: object
      title: memberships_with_policies
    iam_roles:
      description: List of role names for the user at the account.
      items:
        example: Account Administrator
        maxLength: 120
        type: string
      readOnly: true
      type: array
    iam_schemas-account:
      allOf:
      - $ref: '#/components/schemas/iam_account'
      readOnly: true
    iam_schemas-status:
      description: Status of this membership.
      enum:
      - accepted
      - pending
      - rejected
      example: accepted
      type: string
    iam_access:
      description: Allow or deny operations against the resources.
      enum:
      - allow
      - deny
      example: allow
      type: string
    iam_resource_group:
      description: A group of scoped resources.
      properties:
        id:
          description: Identifier of the group.
          example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1
          readOnly: true
          type: string
        meta:
          description: Attributes associated to the resource group.
          example:
            editable: 'false'
          properties:
            key:
              type: string
            value:
              type: string
          type: object
        name:
          description: Name of the resource group.
          example: com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4
          readOnly: true
          type: string
        scope:
          description: The scope associated to the resource group
          items:
            $ref: '#/components/schemas/iam_scope'
          type: array
      required:
      - id
      - scope
      type: object
    iam_properties-name:
      description: Account name
      example: Demo Account
      maxLength: 100
      type: string
    iam_permission_group:
      description: A named group of permissions that map to a group of operations against resources.
      properties:
        id:
          description: Identifier of the group.
          example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1
          readOnly: true
          type: string
        meta:
          description: Attributes associated to the permission group.
          example:
            label: load_balancer_admin
            scopes: com.cloudflare.api.account
          properties:
            key:
              type: string
            value:
              type: string
          type: object
        name:
          description: Name of the group.
          example: Load Balancer
          readOnly: true
          type: string
      required:
      - id
      type: object
    iam_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    iam_scope_object:
      description: A scope object represents any resource that can have actions applied against invite.
      properties:
        key:
          $ref: '#/components/schemas/iam_scope_object_key'
      required:
      - key
      type: object
    iam_resource_groups:
      description: A list of resource groups that the policy applies to.
      items:
        $ref: '#/components/schemas/iam_resource_group'
      type: array
    iam_list_member_policy:
      properties:
        access:
          $ref: '#/components/schemas/iam_access'
        id:
          $ref: '#/components/schemas/iam_identifier'
        permission_groups:
          $ref: '#/components/schemas/iam_permission_groups'
        resource_groups:
          $ref: '#/components/schemas/iam_resource_groups'
      title: list_member_policy
    iam_permissions:
      example:
        analytics:
          read: true
          write: false
        zones:
          read: true
          write: true
      properties:
        analytics:
          $ref: '#/components/schemas/iam_grants'
        billing:
          $ref: '#/components/schemas/iam_grants'
        cache_purge:
          $ref: '#/components/schemas/iam_grants'
        dns:
          $ref: '#/components/schemas/iam_grants'
        dns_records:
          $ref: '#/components/schemas/iam_grants'
        lb:
          $ref: '#/components/schemas/iam_grants'
        logs:
          $ref: '#/components/schemas/iam_grants'
        organization:
          $ref: '#/components/schemas/iam_grants'
        ssl:
          $ref: '#/components/schemas/iam_grants'
        waf:
          $ref: '#/components/schemas/iam_grants'
        zone_settings:
          $ref: '#/components/schemas/iam_grants'
        zones:
          $ref: '#/components/schemas/iam_grants'
      type: object
    iam_collection_membership_response:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/iam_membership'
            type: array
        type: object
      title: memberships_with_roles
    iam_membership:
      properties:
        account:
          $ref: '#/components/schemas/iam_schemas-account'
        api_access_enabled:
          $ref: '#/components/schemas/iam_api_access_enabled'
        id:
          $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
        permissions:
          allOf:
          - $ref: '#/components/schemas/iam_permissions'
          description: All access permissions for the user at the account.
          readOnly: true
        roles:
          $ref: '#/components/schemas/iam_roles'
        status:
          $ref: '#/components/schemas/iam_schemas-status'
      type: object
    iam_api-response-single:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-common'
      type: object
    iam_single_membership_response_with_policies:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/iam_membership-with-policies'
        type: object
      title: response_with_policies
  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