Administration
Base URL: https://api.amplience.net/v2/content
Authorization and status codes
For authorization and status codes see the API Reference overview.
AdministrationLink copied!
| Method | Endpoint | Summary |
|---|---|---|
GET | /admin | List administrative operations |
GET | /admin/access | Manage access to resources |
GET | /admin/access/{resource}/{resourceId} | List operations on a resource |
GET | /admin/access/{resource}/{resourceId}/members | List members on a resource |
GET | /admin/access/{resource}/{resourceId}/members/{sid} | Get a member by id |
DELETE | /admin/access/{resource}/{resourceId}/members/{sid}/permissions/{permissions} | Revoking permissions |
GET | /admin/modules | Manage modules on resources |
GET | /admin/modules/hubs/{hubId} | List module operations on a hub |
POST | /admin/modules/hubs/{hubId}/algolia-search | Enable the search index module on a hub |
POST | /admin/modules/hubs/{hubId}/content-delivery-2 | Enable the content delivery v2 module on a hub |
List administrative operationsLink copied!
GET /admin
https://api.amplience.net/v2/content/admin
Lists the available administrative operations.
Responses
| Status | Description |
|---|---|
| 200 | List of HAL links to perform the desired operations |
Response Example (200)
Manage access to resourcesLink copied!
GET /admin/access
https://api.amplience.net/v2/content/admin/access
With the ability to manage access you can control which users have which permissions to the resources you administer.
Responses
| Status | Description |
|---|---|
| 200 | List of HAL links to manage permissions of users for resources |
Response Example (200)
List operations on a resourceLink copied!
GET /admin/access/{resource}/{resourceId}
https://api.amplience.net/v2/content/admin/access/{resource}/{resourceId}
Given the id of a resource for which you are an administrator, you can see the various operations that you can perform. Simply follow the appropriate link for the resource passing in the id.
| Resource Type | Required Functional Permissions | Required ACLs |
|---|---|---|
| hubs | CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS CONTENT:FUNCTIONAL:HUB:MANAGE_ACCESS | Hub - READ``Hub - MANAGE_ACCESS |
| content-repositories | CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS CONTENT:FUNCTIONAL:REPOSITORY:MANAGE_ACCESS | Hub - READ ContentRepository - MANAGE_ACCESS |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
resource | path | string (hubs, content-repositories) | ✓ | Resource Type Example: hubs |
resourceId | path | string | ✓ | Resource ID Example: 00112233445566778899aabb |
Responses
| Status | Description |
|---|---|
| 200 | List of resource Operations |
Response example (200): Hubs
Response example (200): Content repositories
List members on a resourceLink copied!
GET /admin/access/{resource}/{resourceId}/members
https://api.amplience.net/v2/content/admin/access/{resource}/{resourceId}/members
The memebrs link will list the memebrs that have access to a particular resource. This includes the member's id (sid) and the list of permissions they have.
| Resource Type | Required Functional Permissions | Required ACLs |
|---|---|---|
| hubs | CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS CONTENT:FUNCTIONAL:HUB:MANAGE_ACCESS | Hub - READ Hub - MANAGE_ACCESS |
| content-repositories | CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS CONTENT:FUNCTIONAL:REPOSITORY:MANAGE_ACCESS | Hub - READ ContentRepository - MANAGE_ACCESS |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
resource | path | string (hubs, content-repositories) | ✓ | Resource Type Example: hubs |
resourceId | path | string | ✓ | Resource ID Example: 00112233445566778899aabb |
Responses
| Status | Description |
|---|---|
| 200 | List of resource members |
Response example (200): hub
Response example (200): content-repository
Get a member by idLink copied!
GET /admin/access/{resource}/{resourceId}/members/{sid}
https://api.amplience.net/v2/content/admin/access/{resource}/{resourceId}/members/{sid}
Given a resource and a member id you can navigate directly to a specific member by following the "member" link from the resource.
| Resource Type | Required Functional Permissions | Required ACLs |
|---|---|---|
| hubs | CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS CONTENT:FUNCTIONAL:HUB:MANAGE_ACCESS | Hub - READ Hub - MANAGE_ACCESS |
| content-repositories | CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS CONTENT:FUNCTIONAL:REPOSITORY:MANAGE_ACCESS | Hub - READ ContentRepository - MANAGE_ACCESS |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
resource | path | string (hubs, content-repositories) | ✓ | Resource Type Example: hubs |
resourceId | path | string | ✓ | Resource ID Example: 00112233445566778899aabb |
sid | path | string | ✓ | Member ID Example: alice |
Responses
| Status | Description |
|---|---|
| 200 | The requested member |
Response example (200): hub
Revoking permissionsLink copied!
DELETE /admin/access/{resource}/{resourceId}/members/{sid}/permissions/{permissions}
https://api.amplience.net/v2/content/admin/access/{resource}/{resourceId}/members/{sid}/permissions/{permissions}
Revoke access to a specific resource by deleting a member's permission. From a member, follow the revoke-permission link passing in the permission to delete. You can specify one or multiple permissions. Multiple permissions are comma separated.
| Resource Type | Required Functional Permissions | Required ACLs |
|---|---|---|
| hubs | CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS CONTENT:FUNCTIONAL:HUB:MANAGE_ACCESS | Hub - READ Hub - MANAGE_ACCESS |
| content-repositories | CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS CONTENT:FUNCTIONAL:REPOSITORY:MANAGE_ACCESS | Hub - READ ContentRepository - MANAGE_ACCESS |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
resource | path | string (hubs, content-repositories) | ✓ | Resource Type Example: hubs |
resourceId | path | string | ✓ | Resource ID Example: 00112233445566778899aabb |
sid | path | string | ✓ | Member ID Example: alice |
permissions | path | string | ✓ | Permission(s) to revoke (comma separated list) Example: READ,EDIT |
Responses
| Status | Description |
|---|---|
| 204 | No Content |
Manage modules on resourcesLink copied!
GET /admin/modules
https://api.amplience.net/v2/content/admin/modules
Modules offer additional functionality which is not enabled by default. With the ability to manage modules you can control which modules are enabled on the resources you administer.
Responses
| Status | Description |
|---|---|
| 200 | List of HAL links to manage modules on resources |
Response Example (200)
List module operations on a hubLink copied!
GET /admin/modules/hubs/{hubId}
https://api.amplience.net/v2/content/admin/modules/hubs/{hubId}
Given the id of a hub for which you are an administrator, you can see the various module management operations that you can perform. Simply follow the appropriate link for the resource passing in the id.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
hubId | path | string | ✓ | Hub ID Example: 00112233445566778899aabb |
Responses
| Status | Description |
|---|---|
| 200 | List of hub module management operations |
Response Example (200)
Enable the search index module on a hubLink copied!
POST /admin/modules/hubs/{hubId}/algolia-search
https://api.amplience.net/v2/content/admin/modules/hubs/{hubId}/algolia-search
Enable the Search Indexes module (Algolia Search) on the specified hub. Simply follow the appropriate link for the resource passing in the id.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
hubId | path | string | ✓ | Hub ID Example: 00112233445566778899aabb |
Responses
| Status | Description |
|---|---|
| 200 | The updated hub with the module enabled |
Response Example (200)
Enable the content delivery v2 module on a hubLink copied!
POST /admin/modules/hubs/{hubId}/content-delivery-2
https://api.amplience.net/v2/content/admin/modules/hubs/{hubId}/content-delivery-2
Enable the Content Delivery v2 module on the specified hub. Simply follow the appropriate link for the resource passing in the id.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
hubId | path | string | ✓ | Hub ID Example: 00112233445566778899aabb |
Responses
| Status | Description |
|---|---|
| 200 | The updated hub with the module enabled |