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-administrator-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 SecurityHub Administrator API
  version: '2018-10-26'
  description: Generated from AWS's published Smithy model for AWS SecurityHub. 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://securityhub.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Administrator
paths:
  /administrator:
    post:
      operationId: AcceptAdministratorInvitation
      summary: Accept Administrator Invitation
      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. Accepts the invitation to be a member account and be monitored by the Security Hub CSPM administrator account that the invitation was sent from. This operation is only used by member accounts that are not added through Organizations. When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptAdministratorInvitationResponse'
        '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/AcceptAdministratorInvitationRequest'
            example:
              AdministratorId: '123456789012'
              InvitationId: 7ab938c5d52d7904ad09f9e7c20cc4eb
      tags:
      - Administrator
    get:
      operationId: GetAdministratorAccount
      summary: Get Administrator Account
      description: Provides the details for the Security Hub CSPM administrator account for the current member account. Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAdministratorAccountResponse'
        '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/GetAdministratorAccountRequest'
      tags:
      - Administrator
  /administrator/disassociate:
    post:
      operationId: DisassociateFromAdministratorAccount
      summary: Disassociate From Administrator Account
      description: Disassociates the current Security Hub CSPM member account from the associated administrator account. This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisassociateFromAdministratorAccountResponse'
        '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/DisassociateFromAdministratorAccountRequest'
      tags:
      - Administrator
components:
  schemas:
    InvalidInputException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    GetAdministratorAccountResponse:
      type: object
      properties:
        Administrator:
          $ref: '#/components/schemas/Invitation'
    GetAdministratorAccountRequest:
      type: object
      properties: {}
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    DisassociateFromAdministratorAccountRequest:
      type: object
      properties: {}
    DisassociateFromAdministratorAccountResponse:
      type: object
      properties: {}
    AcceptAdministratorInvitationResponse:
      type: object
      properties: {}
    AcceptAdministratorInvitationRequest:
      type: object
      properties:
        AdministratorId:
          type: string
          description: The account ID of the Security Hub CSPM administrator account that sent the invitation.
        InvitationId:
          type: string
          description: The identifier of the invitation sent from the Security Hub CSPM administrator account.
      required:
      - AdministratorId
      - InvitationId
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    InternalException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    Invitation:
      type: object
      properties:
        AccountId:
          type: string
          description: The account ID of the Security Hub CSPM administrator account that the invitation was sent from.
        InvitationId:
          type: string
          description: The ID of the invitation sent to the member account.
        InvitedAt:
          type: string
          format: date-time
          description: The timestamp of when the invitation was sent.
        MemberStatus:
          type: string
          description: The current status of the association between the member and administrator accounts.
    InvalidAccessException:
      type: object
      properties:
        Message:
          type: string
        Code:
          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: securityhub
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/securityhub/service/2018-10-26/securityhub-2018-10-26.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)