{ "opencollection": "1.0.0", "info": { "name": "Aiven API Documentation Account Organizations API", "version": "v1" }, "items": [ { "info": { "name": "Organizations", "type": "folder" }, "items": [ { "info": { "name": "List the other organizations that existing managed users are part of", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/organization/:organization_id/discovered-organizations", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "

This endpoint may be changed or removed at any time. Don't use it in production environments.

" }, { "info": { "name": "Retrieve authentication configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/organization/:organization_id/config/authentication", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "

Retrieve current authentication configuration for an organization.

" }, { "info": { "name": "Update authentication configuration", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.aiven.io/v1/organization/:organization_id/config/authentication", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "

Update current authentication configuration for an organization.

" }, { "info": { "name": "Get information about an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/organization/:organization_id", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get information about an organization" }, { "info": { "name": "Update organization's details", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.aiven.io/v1/organization/:organization_id", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update organization's details" }, { "info": { "name": "Delete an organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.aiven.io/v1/organization/:organization_id", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" }, { "name": "recursive", "value": "", "type": "query", "description": "Delete all resources in the organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "

This endpoint may be changed or removed at any time. Don't use it in production environments.

" }, { "info": { "name": "List access for organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/organization/:organization_id/governance/access", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" }, { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor" }, { "name": "limit", "value": "", "type": "query", "description": "Limit results to this number" }, { "name": "resource_name", "value": "", "type": "query", "description": "Filter by resource name" }, { "name": "owner_user_group_id", "value": "", "type": "query", "description": "Filter by owner user group ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "

This endpoint may be changed or removed at any time. Don't use it in production environments.

" }, { "info": { "name": "Create organization access", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/organization/:organization_id/governance/access", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "

This endpoint may be changed or removed at any time. Don't use it in production environments.

" }, { "info": { "name": "Get organization access credentials", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/organization/:organization_id/governance/access/:access_id/credentials", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" }, { "name": "access_id", "value": "", "type": "path", "description": "Access Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "

This endpoint may be changed or removed at any time. Don't use it in production environments.

" }, { "info": { "name": "Get organization access details", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/organization/:organization_id/governance/access/:access_id", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" }, { "name": "access_id", "value": "", "type": "path", "description": "Access Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "

This endpoint may be changed or removed at any time. Don't use it in production environments.

" }, { "info": { "name": "Delete organization access", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.aiven.io/v1/organization/:organization_id/governance/access/:access_id", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" }, { "name": "access_id", "value": "", "type": "path", "description": "Access Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "

This endpoint may be changed or removed at any time. Don't use it in production environments.

" }, { "info": { "name": "Get organization IP range allowlist", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/organization/:organization_id/config/api-client-ip-allowlist", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get organization IP range allowlist" }, { "info": { "name": "Set organization IP range allowlist", "type": "http" }, "http": { "method": "PUT", "url": "https://api.aiven.io/v1/organization/:organization_id/config/api-client-ip-allowlist", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Set organization IP range allowlist" }, { "info": { "name": "List projects under the organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/organization/:organization_id/projects", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List projects under the organization" }, { "info": { "name": "Create project under the organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/organization/:organization_id/projects", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create project under the organization" }, { "info": { "name": "Retrieve project under the organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/organization/:organization_id/project/:project_id", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" }, { "name": "project_id", "value": "", "type": "path", "description": "Project Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve project under the organization" }, { "info": { "name": "Update project under the organization", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.aiven.io/v1/organization/:organization_id/project/:project_id", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" }, { "name": "project_id", "value": "", "type": "path", "description": "Project Id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "

Moving a project to a different unit requires organization admin privileges (role:organization:admin). Moving to a different organization requires admin privileges in both organizations, and specifying both the target organization and the target parent unit IDs.

" }, { "info": { "name": "Delete project under the organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.aiven.io/v1/organization/:organization_id/project/:project_id", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" }, { "name": "project_id", "value": "", "type": "path", "description": "Project Id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete project under the organization" }, { "info": { "name": "Accept a user invitation to the organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/organization/:organization_id/invitation/:user_email", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" }, { "name": "user_email", "value": "", "type": "path", "description": "Email address" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Accept a user invitation to the organization" }, { "info": { "name": "Remove an invitation to the organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.aiven.io/v1/organization/:organization_id/invitation/:user_email", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" }, { "name": "user_email", "value": "", "type": "path", "description": "Email address" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Remove an invitation to the organization" }, { "info": { "name": "List user invitations to the organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/organization/:organization_id/invitation", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List user invitations to the organization" }, { "info": { "name": "Invite a user to the organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/organization/:organization_id/invitation", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of an organization" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Invite a user to the organization" }, { "info": { "name": "List organizations the user belongs to", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/organizations", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List organizations the user belongs to" }, { "info": { "name": "Create an organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/organizations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create an organization" } ] } ], "bundled": true }