Organization Settings
Get a list of accessible Organizations
This API call lists all the Organizations accessible to the user represented by the token.
GET https://api.video.ibm.com/organizations.json
Example of the request:
GET /organizations.json HTTP/1.1Host: api.video.ibm.comAuthorization: Bearer 3c2573673b782f6544405a22636f3d5d3b6f3950
The token in the above call is only an example.
Success response
Upon success, a set of key-value pairs is returned under an organizations element with an HTTP Status code of 200.
| KEY | TYPE | DESCRIPTION |
|---|---|---|
id | string | The unique id of the Organization |
name | string | The name of the Organization |
Example of a success response:
{"organizations": [{"id": "ZzzqXZ","name": "My Organization"}]}
Error responses
Possible error responses:
| HTTP RESPONSE CODE | ERROR CONDITIONS |
|---|---|
| 401 Unauthorized | The provided access token is missing, revoked, expired or malformed |
| 403 Forbidden | The provided access token has no access to the user |
| 503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |
Get an Organization
This API call returns the name of an Organization.
GET https://api.video.ibm.com/organizations/{organizationId}.json
Example of the request:
GET /organization/ZzzqXZ.json HTTP/1.1Host: api.video.ibm.comAuthorization: Bearer 3c2573673b782f6544405a22636f3d5d3b6f3950
The token in the above call is only an example.
Success response
Upon success, the Organization name is returned with an HTTP Status code of 200.
| KEY | TYPE | DESCRIPTION |
|---|---|---|
name | string | The name of the Organization |
Example of a success response:
{"name": "My Organization"}
Error responses
Possible error responses:
| HTTP RESPONSE CODE | ERROR CONDITIONS |
|---|---|
| 401 Unauthorized | The provided access token is missing, revoked, expired or malformed |
| 403 Forbidden | The provided access token has no access to the user |
| 503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |
Update an Organization
This API call let’s you update an Organization.
PUT https://api.video.ibm.com/organizations/{organizationId}.json
Parameters
The parameters for the POST request:
| PARAMETER | TYPE | IMPORTANCE | DESCRIPTION |
|---|---|---|---|
name | string | REQUIRED | Organization name |
The Content-Type of the request should be application/x-www-form-urlencoded.
Example of the request:
PUT /organization/ZzzqXZ.json HTTP/1.1Host: api.video.ibm.comAuthorization: Bearer 3c2573673b782f6544405a22636f3d5d3b6f3950Content-Type: application/x-www-form-urlencodedname=My+new+Organization+name
The token in the above call is only an example.
Success response
Upon success the response body is empty with an HTTP Status code of 204.
Error responses
Possible error responses:
| HTTP RESPONSE CODE | ERROR CONDITIONS |
|---|---|
| 400 Bad Request | We couldn’t update the Organization with the provided parameters (eg.: empty name) |
| 401 Unauthorized | The provided access token is missing, revoked, expired or malformed |
| 403 Forbidden | The provided access token has no access to the user |
| 503 Service Unavailable | There is a temporary error on the server which makes it impossible to serve the request |