A Distributed Cloud AIP organization is comprised of the unique combination of your Agents, monitored infrastructure, and users.
Each organization must have at least one Owner, but can have many members with different roles, including Users, Readers, and additional Owners. For more information about roles in Distributed Cloud AIP, see Account Roles.
The organization endpoints help you view a list of organization members, invite new or existing Distributed Cloud AIP users to your organization, and remove users from your organization.
This method enables you to get a list of all of the members of your organization.
Find all of the members of your your organization:
https://api.threatstack.com/v2/organizations/members
Find only the enabled members of an organization:
https://api.threatstack.com/v2/organizations/members?enabledOnly=true
OK
Bad parameters
Unauthorized response
The user is not allowed to perform this action
The resource was not found
Rate limit hit
An internal error has occurred
{- "id": "string",
- "displayName": "string",
- "email": "string",
- "lastAuthenticatedAt": "string",
- "role": "string",
- "ssoEnabled": true,
- "mfaEnabled": true,
- "userEnabled": true
}
This method enables you add an existing user to an existing organization.
NOTE
- Accounts with the Owner role for this organization can assign new users any role (Owner, User, or Reader).
- Accounts with the User role for this organization can assign new users the User or Reader role
- For more information about roles in Distributed Cloud AIP, see Account Roles.
Add an existing user to your existing organization:
https://api.threatstack.com/v2/organizations/members
OK
Bad parameters
Unauthorized response
The user is not allowed to perform this action
The resource was not found
Rate limit hit
An internal error has occurred
{- "id": "string",
- "role": "owner"
}
{- "id": "string",
- "displayName": "string",
- "email": "string",
- "lastAuthenticatedAt": "string",
- "role": "string",
- "ssoEnabled": true,
- "mfaEnabled": true,
- "userEnabled": true
}
This method allows you to remove a user from an organization.
NOTE
Remove a user from your organization:
https://api.threatstack.com/v2/organizations/members/{userId}
No content
Bad parameters
Unauthorized response
The user is not allowed to perform this action
The resource was not found
Rate limit hit
An internal error has occurred
{- "message": "string"
}
This method allows you to add a new Distributed Cloud AIP user to an existing organization.
NOTE
- Accounts with the Owner role for this organization can assign new users any role (Owner, User, or Reader).
- Accounts with the User role for this organization can assign new users the User or Reader role
- For more information about roles in Distributed Cloud AIP, see Account Roles.
Invite a new Distributed Cloud AIP user to your organization:
https://api.threatstack.com/v2/organizations/invites
OK
Bad parameters
Unauthorized response
The user is not allowed to perform this action
The resource was not found
Rate limit hit
An internal error has occurred
{- "email": "string",
- "role": "owner"
}
{- "sentToEmail": "string",
- "status": "string",
- "role": "owner"
}