Getting Started with Organization Management
The Organization Management API lets partners and administrators manage organizations, members, roles, and API keys programmatically through the Red Sift IAM service.
Prerequisites
Section titled “Prerequisites”- A Red Sift partner or admin account — contact Red Sift Support to have an organization created for you
- Familiarity with Authentication (same
Api-Keyheader scheme)
Organization API keys
Section titled “Organization API keys”Organization-level API keys provide access to manage resources across an organization, as opposed to individual user API keys which are scoped to a single user.
Creating an organization API key
Section titled “Creating an organization API key”Organization API keys are managed from the Red Sift IAM console under the Organizations tab of your profile:
| Region | URL |
|---|---|
| UK | iam.redsift.cloud/profile?tab=organizations |
| EU | iam.eu.redsift.cloud/profile?tab=organizations |
| US | iam.us.redsift.cloud/profile?tab=organizations |
- Navigate to Profile → Organizations in the IAM console
- Select the API Keys tab
- Click Create API Key
- Give the key a descriptive name and select the appropriate permissions
- Copy the key — it will not be shown again
Using an organization API key
Section titled “Using an organization API key”Include the key in the Authorization header, the same way as a user API key:
curl -H "Authorization: Api-Key YOUR_ORG_API_KEY" \ https://iam.redsift.cloud/v1/organizationsRegional endpoints
Section titled “Regional endpoints”The Organization Management API is served from the IAM regional endpoints:
| Region | Endpoint |
|---|---|
| UK | https://iam.redsift.cloud |
| EU | https://iam.eu.redsift.cloud |
| US | https://iam.us.redsift.cloud |
Use the endpoint that matches the region where your organization is provisioned.
Organization access management
Section titled “Organization access management”Members
Section titled “Members”Organization administrators can invite, remove, and manage members. Each member is assigned one or more roles that control what they can access.
Roles define a set of permissions granted to organization members. Common roles include:
- Admin — Full access to organization settings, members, and all products
- Reader — Read-only access to dashboards and reports
Next steps
Section titled “Next steps”- Explore the Organization Management API Reference for the full list of endpoints
- Review Authentication for details on regional endpoints and key management