Client Reference
Organizations
Organizations endpoint reference.
List
Retrieve a list of organizations a particular user has access to.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
params | array | No | [] | Array containing the necessary params. |
php
$response = $client->organizations()->list([]);
Create
Create a new organization for a user.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
values | array | Yes | Organization values, requires name. |
php
$response = $client->organizations()->create([]);
Get
Retrieve the details of a certain organization.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
organizationId | string | Yes | Organization identifier. |
php
$response = $client->organizations()->get('ORGANIZATION_ID');
Update
Modify organization.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
organizationId | string | Yes | Organization identifier. | |
values | array | No | [] | Organization values, e.g. name. |
php
$response = $client->organizations()->update('ORGANIZATION_ID', []);
Delete
Delete an organization. The organization MUST be empty before deleting.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
organizationId | string | Yes | Organization identifier. |
php
$response = $client->organizations()->delete('ORGANIZATION_ID');
Accounts
List the accounts that belong to an organization.
Filters come in four flavours for both name and account_pubname: an
exact match, or one of .startsWith, .endsWith and .contains. All of
them are case-insensitive.
Paging here is by opaque token rather than page number: pass the
page_token from the previous response to get the next page.
$client->organizations()->accounts('ORGANIZATION_ID', [
'name.startsWith' => 'prod',
'order_by' => 'account_name',
]);
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
organizationId | string | Yes | Organization identifier. | |
params | array | No | [] | Query Parameters: `account_pubname` and `name` — each also accepting `.startsWith`, `.endsWith` and `.contains` — plus `order_by` (`account_name`), `direction` (`asc` or `desc`), `page_token` and `page_size` (defaults to `10`). |
php
$response = $client->organizations()->accounts('ORGANIZATION_ID', []);
Shares
List an organization's shares.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
organizationId | string | Yes | Organization identifier. | |
params | array | No | [] | Query Parameters: `status` (`active`, `deleting` or `deleted`), `kind` (`sent` or `received`), `target_type` (`account` or `organization`), `resource_types`, `order` (`name` or `created`), `direction` (`asc` or `desc`), `page` and `per_page`. |
php
$response = $client->organizations()->shares('ORGANIZATION_ID', []);