Organizations

List organizations#

GET /api/organizations

Your organization, with its management account. Use its id in the path of every other endpoint.

Response

  • organizations (array of objects): The matching organizations.

    • id (string (uuid)): The organization's ID, used in every path under it.
    • name (string): The organization's name.
    • onboarding (string): How far the organization is through connecting its AWS accounts. One of pending, complete, outdated, hidden.

    • management_account (object): The AWS Organizations management account, once it is connected.

      • id (string (uuid)): The account's MilkStraw AI ID.
      • nickname (string): The account's name in AWS Organizations.
      • account_id (string): The 12-digit AWS account ID.
      • access (string): Whether MilkStraw AI can read the account. One of denied, granted, suspended, closed.

Errors: 401, 403, 429. See errors.

Get an organization#

GET /api/organizations/{organization_id}

One organization, with its AWS accounts and when MilkStraw AI last read them.

Parameters

NameInTypeDescription
organization_idpathstring (uuid)The organization's ID, from the organizations list. Required.

Response

  • organization (object): The organization.

    • id (string (uuid)): The organization's ID, used in every path under it.
    • name (string): The organization's name.
    • onboarding (string): How far the organization is through connecting its AWS accounts. One of pending, complete, outdated, hidden.

    • management_account (object): The AWS Organizations management account, once it is connected.

      • id (string (uuid)): The account's MilkStraw AI ID.
      • nickname (string): The account's name in AWS Organizations.
      • account_id (string): The 12-digit AWS account ID.
      • access (string): Whether MilkStraw AI can read the account. One of denied, granted, suspended, closed.
    • external_id (string): The external ID MilkStraw AI passes when it assumes the role in your accounts.
    • role_name (string): The IAM role MilkStraw AI assumes in your accounts.
    • root_id (string or null): The root ID of your AWS organization, once the management account is connected.

    • stacks (object): The CloudFormation stacks deployed for MilkStraw AI, with their versions.

      • management_stack (object): The stack in the management account.

        • name (string): The stack's name.
        • version (string): The version of MilkStraw AI's template it runs.

      • stackset (object): The StackSet that reaches the member accounts.

        • name (string): The stack's name.
        • version (string): The version of MilkStraw AI's template it runs.
    • last_scanned_at (string or null): When MilkStraw AI last read your AWS data.

    • accounts (array of objects): The organization's AWS accounts.

      • id (string (uuid)): The account's MilkStraw AI ID.
      • nickname (string): The account's name in AWS Organizations.
      • account_id (string): The 12-digit AWS account ID.
      • access (string): Whether MilkStraw AI can read the account. One of denied, granted, suspended, closed.

Errors: 401, 403, 404, 429. See errors.