Amazon Detective Organizations API

AWS Organizations integration operations

GitHub OpenAPI

Operations 5

POST /orgs/describeOrganizationConfiguration Describe Organization Configuration #
POST /orgs/disableAdminAccount Disable Organization Admin Account #
POST /orgs/enableAdminAccount Enable Organization Admin Account #
POST /orgs/adminAccountslist List Organization Admin Accounts #
POST /orgs/updateOrganizationConfiguration Update Organization Configuration #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/amazon-detective:amazon-detective-organizations-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.

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

OpenAPI Specification

amazon-detective-organizations-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Detective Organizations API
  version: '2018-10-26'
  description: Generated from AWS's published Smithy model for Amazon Detective. 5 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://api.detective.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /orgs/describeOrganizationConfiguration:
    post:
      operationId: DescribeOrganizationConfiguration
      summary: Describe Organization Configuration
      description: Returns information about the configuration for the organization behavior graph. Currently indicates whether
        to automatically enable new organization accounts as member accounts. Can only be called by the Detective administrator
        account for the organization.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeOrganizationConfigurationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeOrganizationConfigurationRequest'
      tags:
      - Organizations
  /orgs/disableAdminAccount:
    post:
      operationId: DisableOrganizationAdminAccount
      summary: Disable Organization Admin Account
      description: Removes the Detective administrator account in the current Region. Deletes the organization behavior graph.
        Can only be called by the organization management account. Removing the Detective administrator account does not affect
        the delegated administrator account for Detective in Organizations. To remove the delegated administrator account
        in Organizations, use the Organizations API. Removing the delegated administrator account also removes the Detective
        administrator account in all Regions, except for Regions where the Detective administrator account is the organization
        management account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              type: string
      tags:
      - Organizations
  /orgs/enableAdminAccount:
    post:
      operationId: EnableOrganizationAdminAccount
      summary: Enable Organization Admin Account
      description: Designates the Detective administrator account for the organization in the current Region. If the account
        does not have Detective enabled, then enables Detective for that account and creates a new behavior graph. Can only
        be called by the organization management account. If the organization has a delegated administrator account in Organizations,
        then the Detective administrator account must be either the delegated administrator account or the organization management
        account. If the organization does not have a delegated administrator account in Organizations, then you can choose
        any account in the organization. If you choose an account other than the organization management account, Detective
        calls Organizations to make that account the delegated administrator account for Detective. The organization management
        account cannot be the delegated administrator account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnableOrganizationAdminAccountRequest'
      tags:
      - Organizations
  /orgs/adminAccountslist:
    post:
      operationId: ListOrganizationAdminAccounts
      summary: List Organization Admin Accounts
      description: Returns information about the Detective administrator account for an organization. Can only be called by
        the organization management account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOrganizationAdminAccountsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListOrganizationAdminAccountsRequest'
      tags:
      - Organizations
  /orgs/updateOrganizationConfiguration:
    post:
      operationId: UpdateOrganizationConfiguration
      summary: Update Organization Configuration
      description: Updates the configuration for the Organizations integration in the current Region. Can only be called by
        the Detective administrator account for the organization.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrganizationConfigurationRequest'
      tags:
      - Organizations
components:
  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: detective
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
        ErrorCode:
          type: string
          enum:
          - INVALID_GRAPH_ARN
          - INVALID_REQUEST_BODY
          - INTERNAL_ERROR
          description: The SDK default error code associated with the access denied exception.
        ErrorCodeReason:
          type: string
          description: The SDK default explanation of why access was denied.
        SubErrorCode:
          type: string
          enum:
          - INVALID_GRAPH_ARN
          - INVALID_REQUEST_BODY
          - INTERNAL_ERROR
          description: The error code associated with the access denied exception.
        SubErrorCodeReason:
          type: string
          description: An explanation of why access was denied.
    Administrator:
      type: object
      properties:
        AccountId:
          type: string
          description: The Amazon Web Services account identifier of the Detective administrator account for the organization.
        GraphArn:
          type: string
          description: The ARN of the organization behavior graph.
        DelegationTime:
          type: string
          format: date-time
          description: The date and time when the Detective administrator account was enabled. The value is an ISO8601 formatted
            string. For example, 2021-08-18T16:35:56.284Z.
    DescribeOrganizationConfigurationRequest:
      type: object
      properties:
        GraphArn:
          type: string
          description: The ARN of the organization behavior graph.
      required:
      - GraphArn
    DescribeOrganizationConfigurationResponse:
      type: object
      properties:
        AutoEnable:
          type: boolean
          description: Indicates whether to automatically enable new organization accounts as member accounts in the organization
            behavior graph.
    EnableOrganizationAdminAccountRequest:
      type: object
      properties:
        AccountId:
          type: string
          description: The Amazon Web Services account identifier of the account to designate as the Detective administrator
            account for the organization.
      required:
      - AccountId
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    ListOrganizationAdminAccountsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: For requests to get the next page of results, the pagination token that was returned with the previous
            set of results. The initial request does not include a pagination token.
        MaxResults:
          type: integer
          description: The maximum number of results to return.
    ListOrganizationAdminAccountsResponse:
      type: object
      properties:
        Administrators:
          type: array
          items:
            $ref: '#/components/schemas/Administrator'
          description: The list of Detective administrator accounts.
        NextToken:
          type: string
          description: If there are more accounts remaining in the results, then this is the pagination token to use to request
            the next page of accounts.
    TooManyRequestsException:
      type: object
      properties:
        Message:
          type: string
    UpdateOrganizationConfigurationRequest:
      type: object
      properties:
        GraphArn:
          type: string
          description: The ARN of the organization behavior graph.
        AutoEnable:
          type: boolean
          description: Indicates whether to automatically enable new organization accounts as member accounts in the organization
            behavior graph.
      required:
      - GraphArn
    ValidationException:
      type: object
      properties:
        Message:
          type: string
        ErrorCode:
          type: string
          enum:
          - INVALID_GRAPH_ARN
          - INVALID_REQUEST_BODY
          - INTERNAL_ERROR
          description: The error code associated with the validation failure.
        ErrorCodeReason:
          type: string
          description: An explanation of why validation failed.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/detective/service/2018-10-26/detective-2018-10-26.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)