Instaclustr Logo
Powered by Redocly

Organization Management API

Operations related to Organization Management.

These endpoints require an Organization Management API key. Organization API keys can be retrieved any time from the console by going to the Organization Management page > API Keys.

Retrieve linked accounts

Retrieve all accounts linked to the organization.

SecurityBasic Authentication
Request
path Parameters
organisationId
required
string
Responses
200

Successfully retrieved accounts linked to the organization.

404

Invalid organization id

get/v1/organisations/{organisationId}/linked-accounts
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create a new account.
Create a new account under an organization.


SecurityBasic Authentication 
Request 
path Parameters
organisationId
required
string
 
Request Body schema: application/json
object
 
accountName
string
The name of the new account being created under the Organization


 
Responses 
200
Successfully created a new account for the organization.


400
Invalid Request Params, User is unable to create accounts or unable to link to organization or update billing details.


404
Invalid organization ID.


post/v1/organisations/{organisationId}/linked-accounts
Request samples 
application/json
{
  • "validationMessages": {
    },
  • "accountName": "string"
}
Response samples 
application/json
{
  • "accountId": "string"
}
Unlink an account
Unlink an account from to the organization.


SecurityBasic Authentication 
Request 
path Parameters
organisationId
required
string
 
accountId
required
string
 
Responses 
200
Successfully unlinked account from the organization.


404
Account is not linked to the organization


delete/v1/organisations/{organisationId}/linked-accounts/{accountId}
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get user actions
Get user actions for the organization and its linked accounts


SecurityBasic Authentication 
Request 
path Parameters
organisationId
required
string
 
query Parameters
pageSize
integer <int32>   [ 1 .. 1000 ] 
 Default:  10
Number of records to return per page


 
 Example:  pageSize=50
recordIndex
integer <int32>   >= 0 
 Default:  0
Starting index for the records to return, useful for pagination. e.g. 10 will return records starting from 11


 
actionKinds
Array of strings  unique 
Filter results by types of actions. Multiple actions are allowed. Invalid value will be ignored


Items Enum: "CREATE_ORGANISATION" "LINK_ACCOUNT" "UNLINK_ACCOUNT" "ORGANISATION_UPDATE_BILLING_DETAILS" "SYNC_BILLING_TO_ACCOUNT" "ORGANISATION_SET_IDP_DETAILS" "SYNC_IDP_TO_ACCOUNT" "INVITE_USER" "REVOKE_USER_INVITE" "LINK_USER" "UNLINK_USER" "MIGRATE_CLUSTER" "CREATE_SIGNUP_BLOCK" "DELETE_SIGNUP_BLOCK" "ORGANISATION_GENERATE_API_KEY" "ORGANISATION_REVOKE_API_KEY" "CREATE_CLUSTER" "DELETE_CLUSTER" "REQUEST_CLUSTER_DELETE" "ADD_NODE" "ADD_DATA_CENTRE" "CHANGE_CLUSTER_SETTINGS" "CHANGE_CLUSTER_FIREWALL_RULES" "CREATE_VPC_PEERING_REQUEST" "EDIT_VPC_PEERING_REQUEST" "DELETE_VPC_PEERING_REQUEST" "ACCOUNT_INVITE_USER" "ACCOUNT_ACCEPT_INVITATION" "ACCOUNT_REVOKE_INVITATION" "ACCOUNT_REVOKE_LINK" "ACCOUNT_MODIFY_LINK" "ACCOUNT_CREATE_LINK" "ACCOUNT_GENERATE_API_KEY" "ACCOUNT_REVOKE_API_KEY" "ACCOUNT_ADD_ENCRYPTION_KEY" "ACCOUNT_UPDATE_REGIONS_ENCRYPTION_KEY" "ACCOUNT_REVOKE_ENCRYPTION_KEY" "RESTORE" "BACKUP" "CREATE_BACKUP_SCHEDULE" "DELETE_BACKUP_SCHEDULE" "ADMIN_ADD_CONFIG_OVERRIDE" "ADMIN_DELETE_CONFIG_OVERRIDE" "ADMIN_ADD_KAFKA_LISTENER" "ADMIN_DELETE_KAFKA_LISTENER" "ADMIN_SET_ACCESS_LEVEL" "LIST_BUNDLE_USERS" "CREATE_BUNDLE_USER" "EDIT_BUNDLE_USER" "DELETE_BUNDLE_USER" "RESTART_BUNDLE" "RECONFIGURE_BUNDLE" "RELOAD_BUNDLE" "RESIZE_CDC" "CANCEL_RESIZE_CDC" "RETRY_RESIZE_CDC" "CREATE_KAFKA_TOPIC" "DISPLAY_KAFKA_TOPIC_CONFIG" "EDIT_KAFKA_TOPIC" "DELETE_KAFKA_TOPIC" "DESCRIBE_KAFKA_TOPIC" "LIST_KAFKA_ACLS" "CREATE_KAFKA_ACLS" "DELETE_KAFKA_ACLS" "DEACTIVATE_SERVICE_USER" "REACTIVATE_SERVICE_USER" "CREATE_SERVICE_USER" "DEACTIVATE_SCIM_USER" "REACTIVATE_SCIM_USER" "DEACTIVATE_USER" "UPDATE_SSO_LOGIN_TYPE" "PRIVATE_LINK_MIGRATION_ENABLE" "PRIVATE_LINK_MIGRATION_DISABLE" "ADMIN_ADD_KAFKA_PRIVATE_LINK_LISTENER" "ADMIN_DELETE_KAFKA_PRIVATE_LINK_LISTENER" "ADMIN_ADD_KAFKA_PRIVATE_LINK_IAM_ROLE" "ADMIN_DELETE_KAFKA_PRIVATE_LINK_IAM_ROLE" "MANAGED_IDENTITY_MIGRATION_ENABLE" "MANAGED_IDENTITY_MIGRATION_DISABLE" "MIGRATE_FROM_AZURE_TO_AZUREAZ" "ENABLE_KAFKA_TIERED_STORAGE"  
 Example:  actionKinds=LINK_ACCOUNT
descriptionKeyword
string
Keyword in the action description


 
 Example:  descriptionKeyword=update
account
string
Account ID or name


 
 Example:  account=773e542f-30f7-4d23-a650-69133bedca78
clusterId
string
Cluster Id


 
 Example:  clusterId=2f02e54a-26cd-4929-a24f-c72922b763df
crudOperations
Array of strings  unique 
Operation type in CRUD form. Invalid value will be ignored


Items Enum: "ACCOUNT_LEVEL_USER_ACTIONS_CREATE" "ACCOUNT_LEVEL_USER_ACTIONS_UPDATE" "ACCOUNT_LEVEL_USER_ACTIONS_READ" "ACCOUNT_LEVEL_USER_ACTIONS_DELETE" "ORG_LEVEL_USER_ACTIONS_CREATE" "ORG_LEVEL_USER_ACTIONS_UPDATE" "ORG_LEVEL_USER_ACTIONS_DELETE"  
 Example:  crudOperations=ORG_LEVEL_USER_ACTIONS_CREATE
userName
string
Username


 
 Example:  userName=john
startTime
string
Start timestamp in milliseconds since epoch or ISO formatted date and time


 
 Example:  startTime=2023-11-05T13:15:30Z
endTime
string
End timestamp in milliseconds since epoch or ISO formatted date and time


 
 Example:  endTime=2023-11-05T13:15:30Z
getActionCounts
boolean
 Default:  true
If set to true, the response will include counts of each action type


 
organisationLogsOnly
boolean
 Default:  false
If set to true, the response will include only logs related to the organization


 
accountLogsOnly
boolean
 Default:  false
If set to true, the response will include only logs related to the accounts


 
Responses 
200
Successfully retrieved the user actions for the organization and its linked accounts


401
Unauthorized


403
Forbidden


get/v1/organisations/{organisationId}/user-actions
Request samples 
Response samples 
application/json
[
  • {
    }
]
➔ Next to Pricing information - Node sizes