find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/aws-security-hub:aws-security-hub-invitations-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Aws Security Hub Invitations API
  version: '2018-10-26'
  description: 'Operations tagged Invitations across 2 of this provider''s published API definitions: aws-security-hub-openapi.yml, aws-security-hub-invitations-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://securityhub.{region}.amazonaws.com
  description: AWS Security Hub regional endpoint
  variables:
    region:
      default: us-east-1
tags:
- name: Invitations
paths:
  /invitations:
    get:
      tags:
      - Invitations
      operationId: ListInvitations
      summary: List invitations
      responses:
        '200':
          $ref: '#/components/responses/OK'
      security:
      - SigV4: []
    servers:
    - url: https://securityhub.{region}.amazonaws.com
      description: AWS Security Hub regional endpoint
      variables:
        region:
          default: us-east-1
  /invitations/accept:
    post:
      tags:
      - Invitations
      operationId: AcceptInvitation
      summary: Accept an invitation
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
      security:
      - SigV4: []
    servers:
    - url: https://securityhub.{region}.amazonaws.com
      description: AWS Security Hub regional endpoint
      variables:
        region:
          default: us-east-1
  /invitations/decline:
    post:
      tags:
      - Invitations
      operationId: DeclineInvitations
      summary: Decline invitations
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
      security:
      - SigV4: []
    servers:
    - url: https://securityhub.{region}.amazonaws.com
      description: AWS Security Hub regional endpoint
      variables:
        region:
          default: us-east-1
  /invitations/delete:
    post:
      operationId: DeleteInvitations
      summary: Delete Invitations
      description: We recommend using Organizations instead of Security Hub CSPM invitations to manage your member accounts. For information, see Managing Security Hub CSPM administrator and member accounts with Organizations in the Security Hub CSPM User Guide. Deletes invitations to become a Security Hub CSPM member account. A Security Hub CSPM administrator account can use this operation to delete invitations sent to one or more prospective member accounts. This operation is only used to delete invitations that are sent to prospective member accounts that aren't part of an Amazon Web Services organization. Organization accounts don't receive invitations.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteInvitationsResponse'
              example:
                UnprocessedAccounts: []
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '401':
          description: InvalidAccessException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidAccessException'
        '400':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteInvitationsRequest'
            example:
              AccountIds:
              - '123456789012'
      tags:
      - Invitations
      security:
      - sigv4: []
    servers:
    - url: https://securityhub.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /invitations/count:
    get:
      operationId: GetInvitationsCount
      summary: Get Invitations Count
      description: We recommend using Organizations instead of Security Hub CSPM invitations to manage your member accounts. For information, see Managing Security Hub CSPM administrator and member accounts with Organizations in the Security Hub CSPM User Guide. Returns the count of all Security Hub CSPM membership invitations that were sent to the calling member account, not including the currently accepted invitation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInvitationsCountResponse'
              example:
                InvitationsCount: 3
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '401':
          description: InvalidAccessException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidAccessException'
        '400':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetInvitationsCountRequest'
      tags:
      - Invitations
      security:
      - sigv4: []
    servers:
    - url: https://securityhub.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  responses:
    OK:
      description: Successful response
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
  requestBodies:
    JsonBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
  schemas:
    DeleteInvitationsRequest:
      type: object
      properties:
        AccountIds:
          type: array
          items:
            type: string
          description: The list of member account IDs that received the invitations you want to delete.
      required:
      - AccountIds
    InvalidInputException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    Result:
      type: object
      properties:
        AccountId:
          type: string
          description: An Amazon Web Services account ID of the account that was not processed.
        ProcessingResult:
          type: string
          description: The reason that the account was not processed.
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    GetInvitationsCountResponse:
      type: object
      properties:
        InvitationsCount:
          type: integer
          description: The number of all membership invitations sent to this Security Hub CSPM member account, not including the currently accepted invitation.
    InternalException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    GetInvitationsCountRequest:
      type: object
      properties: {}
    DeleteInvitationsResponse:
      type: object
      properties:
        UnprocessedAccounts:
          type: array
          items:
            $ref: '#/components/schemas/Result'
          description: The list of Amazon Web Services accounts for which the invitations were not deleted. For each account, the list includes the account ID and the email address.
    InvalidAccessException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
  securitySchemes:
    SigV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 signed Authorization header
    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: securityhub
x-refined-from:
- aws-security-hub-openapi.yml
- aws-security-hub-invitations-api-openapi.yml