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

200
404

application/json

[{"accountId": "string",
"accountName": "string",
"accountType": "INSTACLUSTR",
"isAccountPciCompliant": true,
"accountHasBillingDetails": true,
"isEnabledIdpSyncedToOrganisation": true,
"isAccountInvoiced": true,
"isBillingSyncedToOrganisation": true,
"accountSupportContacts": "string",
"accountEmergencyContacts": "string",
"accountMaintenanceContacts": "string",
"areOrgAndAccountSharedProviderAccountsActivelyUsed": true
}
]

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": {"property1": "string",
"property2": "string"
},
"accountName": "string"
}

Response samples

200
400
404

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

200
404

application/json

[{"id": "string",
"name": "string",
"supportContacts": "string",
"emergencyContacts": "string",
"maintenanceContacts": "string",
"blockedEmailDomains": ["string"
],
"features": {"ssoSelfServeEnabled": true
},
"accountCreationBlocked": true,
"blockScimUserRevokeNotification": true
}
]