Chartio Admin API documentation version v1
https://api.chartio.com/{version}
The Chartio Admin API provides programmatic access to select resources within a Chartio organization.
API credentials are managed within the Chartio UI, from the Admin API tab under the settings menu (contact Chartio support if you need access enabled). All endpoints are secured using HTTP Basic Authentication.
The API utilizes the Hypertext Application Language standard to provide links between related API resources, such as paginated collections and nested objects. More information on HAL can be found here: http://stateless.co/hal_specification.html.
- version: required(v1)
/{orgSlug}
The root of the Chartio Admin API for this org.
get /{orgSlug}
The root of the Chartio Admin API for this org.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
HTTP status code 200
Links to resources within this org which can be managed by the currently authenticated service account.
Body
Media type: application/json
Type: object
Properties- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- _embedded: (object)
- chartio:teams: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- chartio:users: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
The collection of dashboards belonging to this org.
Dashboard responses are paginated with a default of 100 dashboards per page. See the _links
metadata at the top level of the response for pagination links.
get /{orgSlug}/dashboards
The collection of dashboards belonging to this org.
Dashboard responses are paginated with a default of 100 dashboards per page. See the _links
metadata at the top level of the response for pagination links.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- _links: required(object)
A collection of links to related resources.
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
- next: (object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- previous: (object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
Example:
{ "self": { "href": "/example-org/items/?page=2" }, "next": { "href": "/example-org/items/?page=3" }, "previous": { "href": "/example-org/items/?page=1" } }
- self: required(object)
- _embedded: (object)
- count: required(integer)
- dashboards: required(array of DashboardResponse)
Items: DashboardResponse
- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- _embedded: (object)
- id: required(integer)
- slug: required(string)
- title: required(string)
- link_sharing_access: required(one of none, viewer, editor)
- created_at: required(datetime)
- updated_at: required(datetime)
Example:
{ "_links": { "self": { "href": "/example-org/dashboards/1" }, "permissions": { "href": "/example-org/dashboards/1/permissions" } }, "id": 1, "slug": "example-dashboard", "title": "Example Dashboard", "link_sharing_access": "none", "created_at": "2020-05-29T00:00:00Z", "updated_at": "2020-05-29T01:00:00Z" }
- _links: required(object)
Example:
{
"_links": {
"self": {
"href": "/example-org/dashboards/"
}
},
"count": 1,
"dashboards": [
{
"_links": {
"self": {
"href": "/example-org/dashboards/1"
},
"permissions": {
"href": "/example-org/dashboards/1/permissions"
}
},
"id": 1,
"slug": "example-dashboard",
"title": "Example Dashboard",
"link_sharing_access": "none",
"created_at": "2020-05-29T00:00:00Z",
"updated_at": "2020-05-29T01:00:00Z"
}
]
}
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
Gets a dashboard.
get /{orgSlug}/dashboards/{dashboardId}
Gets a dashboard.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- dashboardId: required(integer)
The dashboard identifier.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- _embedded: (object)
- id: required(integer)
- slug: required(string)
- title: required(string)
- link_sharing_access: required(one of none, viewer, editor)
- created_at: required(datetime)
- updated_at: required(datetime)
Example:
{
"_links": {
"self": {
"href": "/example-org/dashboards/1"
},
"permissions": {
"href": "/example-org/dashboards/1/permissions"
}
},
"id": 1,
"slug": "example-dashboard",
"title": "Example Dashboard",
"link_sharing_access": "none",
"created_at": "2020-05-29T00:00:00Z",
"updated_at": "2020-05-29T01:00:00Z"
}
HTTP status code 404
Dashboard was not found.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
Create or modify a user or team permission on this dashboard. If an existing permission for this dashboard matches the user or team in the request, that permission will be updated instead of creating a new one.
The collection of user and team permissions for this dashboard.
Permissions are limited to a default of 100 per dashboard. If permissions are paginated, see the _links
metadata at the top level of the response for pagination links.
post /{orgSlug}/dashboards/{dashboardId}/permissions
Create or modify a user or team permission on this dashboard. If an existing permission for this dashboard matches the user or team in the request, that permission will be updated instead of creating a new one.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- dashboardId: required(integer)
The dashboard identifier.
Body
Media type: application/json
Possible types:
TeamPermissionNew
- access_level: required(one of viewer, editor, admin)
- team_id: required(integer)
UserPermissionNew
- user_id: required(integer)
- access_level: required(one of viewer, editor, admin)
Examples:
{
"user_id": 2,
"access_level": "viewer"
}
{
"team_id": 1,
"access_level": "editor"
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- _embedded: required(union of TeamEmbedded or UserEmbedded)
- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- id: required(integer)
- access_level: required(one of viewer, editor, admin)
Examples:
{
"_links": {
"self": {
"href": "/example-org/dashboards/1/permissions/33/"
}
},
"_embedded": {
"team": {
"_links": {
"self": {
"href": "/example-org/teams/3/"
}
},
"id": 3,
"name": "Marketing"
}
},
"id": "33,",
"access_level": "editor"
}
{
"_links": {
"self": {
"href": "/example-org/dashboards/1/permissions/22/"
}
},
"_embedded": {
"user": {
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"id": 2,
"display_name": "Example User",
"email": "user@example.com"
}
},
"id": "22,",
"access_level": "viewer"
}
HTTP status code 201
Body
Media type: application/json
Type: object
Properties- _embedded: required(union of TeamEmbedded or UserEmbedded)
- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- id: required(integer)
- access_level: required(one of viewer, editor, admin)
Examples:
{
"_links": {
"self": {
"href": "/example-org/dashboards/1/permissions/33/"
}
},
"_embedded": {
"team": {
"_links": {
"self": {
"href": "/example-org/teams/3/"
}
},
"id": 3,
"name": "Marketing"
}
},
"id": "33,",
"access_level": "editor"
}
{
"_links": {
"self": {
"href": "/example-org/dashboards/1/permissions/22/"
}
},
"_embedded": {
"user": {
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"id": 2,
"display_name": "Example User",
"email": "user@example.com"
}
},
"id": "22,",
"access_level": "viewer"
}
HTTP status code 400
Attempted to create a permission with a user or team which does not exist in the org, or an invalid permission value.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
get /{orgSlug}/dashboards/{dashboardId}/permissions
The collection of user and team permissions for this dashboard.
Permissions are limited to a default of 100 per dashboard. If permissions are paginated, see the _links
metadata at the top level of the response for pagination links.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- dashboardId: required(integer)
The dashboard identifier.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- _links: required(object)
A collection of links to related resources.
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
- next: (object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- previous: (object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
Example:
{ "self": { "href": "/example-org/items/?page=2" }, "next": { "href": "/example-org/items/?page=3" }, "previous": { "href": "/example-org/items/?page=1" } }
- self: required(object)
- _embedded: (object)
- count: required(integer)
- permissions: required(array of DashboardPermissionResponse)
Items: DashboardPermissionResponse
- _embedded: required(union of TeamEmbedded or UserEmbedded)
- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- id: required(integer)
- access_level: required(one of viewer, editor, admin)
Examples:
{ "_links": { "self": { "href": "/example-org/dashboards/1/permissions/33/" } }, "_embedded": { "team": { "_links": { "self": { "href": "/example-org/teams/3/" } }, "id": 3, "name": "Marketing" } }, "id": "33,", "access_level": "editor" }
{ "_links": { "self": { "href": "/example-org/dashboards/1/permissions/22/" } }, "_embedded": { "user": { "_links": { "self": { "href": "/example-org/users/2/" } }, "id": 2, "display_name": "Example User", "email": "user@example.com" } }, "id": "22,", "access_level": "viewer" }
Example:
{
"_links": {
"self": {
"href": "/example-org/dashboards/1/permissions/"
}
},
"count": "2,",
"permissions": [
{
"_links": {
"self": {
"href": "/example-org/dashboards/1/permissions/33/"
}
},
"_embedded": {
"team": {
"_links": {
"self": {
"href": "/example-org/teams/3/"
}
},
"id": 3,
"name": "Marketing"
}
},
"id": 33,
"access_level": "editor"
},
{
"_links": {
"self": {
"href": "/example-org/dashboards/1/permissions/22/"
}
},
"_embedded": {
"user": {
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"id": 2,
"display_name": "Example User",
"email": "user@example.com"
}
},
"id": 22,
"access_level": "admin"
}
]
}
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
Get an individual dashboard permission.
Update a permission access level.
Update a permission access level.
get /{orgSlug}/dashboards/{dashboardId}/permissions/{permissionId}
Get an individual dashboard permission.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- dashboardId: required(integer)
The dashboard identifier.
- permissionId: required(integer)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- _embedded: required(union of TeamEmbedded or UserEmbedded)
- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- id: required(integer)
- access_level: required(one of viewer, editor, admin)
Examples:
{
"_links": {
"self": {
"href": "/example-org/dashboards/1/permissions/33/"
}
},
"_embedded": {
"team": {
"_links": {
"self": {
"href": "/example-org/teams/3/"
}
},
"id": 3,
"name": "Marketing"
}
},
"id": "33,",
"access_level": "editor"
}
{
"_links": {
"self": {
"href": "/example-org/dashboards/1/permissions/22/"
}
},
"_embedded": {
"user": {
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"id": 2,
"display_name": "Example User",
"email": "user@example.com"
}
},
"id": "22,",
"access_level": "viewer"
}
HTTP status code 404
Permission was not found.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
put /{orgSlug}/dashboards/{dashboardId}/permissions/{permissionId}
Update a permission access level.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- dashboardId: required(integer)
The dashboard identifier.
- permissionId: required(integer)
Body
Media type: application/json
Type: object
Properties- access_level: required(one of viewer, editor, admin)
Example:
{
"access_level": "admin"
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- _embedded: required(union of TeamEmbedded or UserEmbedded)
- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- id: required(integer)
- access_level: required(one of viewer, editor, admin)
Examples:
{
"_links": {
"self": {
"href": "/example-org/dashboards/1/permissions/33/"
}
},
"_embedded": {
"team": {
"_links": {
"self": {
"href": "/example-org/teams/3/"
}
},
"id": 3,
"name": "Marketing"
}
},
"id": "33,",
"access_level": "editor"
}
{
"_links": {
"self": {
"href": "/example-org/dashboards/1/permissions/22/"
}
},
"_embedded": {
"user": {
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"id": 2,
"display_name": "Example User",
"email": "user@example.com"
}
},
"id": "22,",
"access_level": "viewer"
}
HTTP status code 400
An invalid access level was provided.
HTTP status code 404
Permission was not found.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
patch /{orgSlug}/dashboards/{dashboardId}/permissions/{permissionId}
Update a permission access level.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- dashboardId: required(integer)
The dashboard identifier.
- permissionId: required(integer)
Body
Media type: application/json
Type: object
Properties- access_level: required(one of viewer, editor, admin)
Example:
{
"access_level": "admin"
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- _embedded: required(union of TeamEmbedded or UserEmbedded)
- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- id: required(integer)
- access_level: required(one of viewer, editor, admin)
Examples:
{
"_links": {
"self": {
"href": "/example-org/dashboards/1/permissions/33/"
}
},
"_embedded": {
"team": {
"_links": {
"self": {
"href": "/example-org/teams/3/"
}
},
"id": 3,
"name": "Marketing"
}
},
"id": "33,",
"access_level": "editor"
}
{
"_links": {
"self": {
"href": "/example-org/dashboards/1/permissions/22/"
}
},
"_embedded": {
"user": {
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"id": 2,
"display_name": "Example User",
"email": "user@example.com"
}
},
"id": "22,",
"access_level": "viewer"
}
HTTP status code 400
An invalid access level was provided.
HTTP status code 404
Permission was not found.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
delete /{orgSlug}/dashboards/{dashboardId}/permissions/{permissionId}
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- dashboardId: required(integer)
The dashboard identifier.
- permissionId: required(integer)
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
The collection of datasources belonging to this org.
Datasource responses are paginated with a default of 100 datasources per page. See the _links
metadata at the top level of the response for pagination links.
get /{orgSlug}/datasources
The collection of datasources belonging to this org.
Datasource responses are paginated with a default of 100 datasources per page. See the _links
metadata at the top level of the response for pagination links.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- _links: required(object)
A collection of links to related resources.
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
- next: (object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- previous: (object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
Example:
{ "self": { "href": "/example-org/items/?page=2" }, "next": { "href": "/example-org/items/?page=3" }, "previous": { "href": "/example-org/items/?page=1" } }
- self: required(object)
- _embedded: (object)
- count: required(integer)
- datasources: required(array of DataSourceResponse)
Items: DataSourceResponse
- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
- permissions: required(object)
A link to view or modify the user and team permissions for this datasource.
- href: required(string)
Example:
{ "permissions": { "href": "/example-org/datasources/3/permissions/" }, "schema-sync": { "href": "/example-org/datasources/3/schema-sync/" } }
- self: required(object)
- _embedded: (object)
- id: required(integer)
- alias: required(string)
- slug: required(string)
- dstype: required(string)
- created_at: required(datetime)
- updated_at: required(datetime)
- last_reflected: required(union of datetime or nil)
- last_refreshed_at: required(union of datetime or nil)
Example:
{ "id": 3, "alias": "Data Warehouse", "dstype": "Redshift", "slug": "data-warehouse", "created_at": "2019-03-04T00:00:00Z", "updated_at": "2019-03-12T00:00:00Z", "last_reflected": "2019-03-12T00:00:00Z", "last_refreshed_at": null, "_links": { "self": { "href": "/example-org/datasources/3/" }, "permissions": { "href": "/example-org/datasources/3/permissions/" }, "schema-sync": { "href": "/example-org/datasources/3/schema-sync/" } } }
- _links: required(object)
Example:
{
"count": 1,
"_links": {
"self": {
"href": "/example-org/datasources/"
},
"next": {
"href": "/example-org/datasources/?page=2"
}
},
"datasources": [
{
"id": 3,
"alias": "Data Warehouse",
"dstype": "Redshift",
"slug": "data-warehouse",
"created_at": "2019-03-04T00:00:00Z",
"updated_at": "2019-03-12T00:00:00Z",
"last_reflected": "2019-03-12T00:00:00Z",
"last_refreshed_at": null,
"_links": {
"self": {
"href": "/example-org/datasources/3/"
},
"permissions": {
"href": "/example-org/datasources/3/permissions/"
}
}
}
]
}
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
Gets a datasource
Update the attributes of a Chartio datasource.
get /{orgSlug}/datasources/{datasourceId}
Gets a datasource
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- datasourceId: required(integer)
The datasource identifier.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
- permissions: required(object)
A link to view or modify the user and team permissions for this datasource.
- href: required(string)
Example:
{ "permissions": { "href": "/example-org/datasources/3/permissions/" }, "schema-sync": { "href": "/example-org/datasources/3/schema-sync/" } }
- self: required(object)
- _embedded: (object)
- id: required(integer)
- alias: required(string)
- slug: required(string)
- dstype: required(string)
- created_at: required(datetime)
- updated_at: required(datetime)
- last_reflected: required(union of datetime or nil)
- last_refreshed_at: required(union of datetime or nil)
Example:
{
"id": 3,
"alias": "Data Warehouse",
"dstype": "Redshift",
"slug": "data-warehouse",
"created_at": "2019-03-04T00:00:00Z",
"updated_at": "2019-03-12T00:00:00Z",
"last_reflected": "2019-03-12T00:00:00Z",
"last_refreshed_at": null,
"_links": {
"self": {
"href": "/example-org/datasources/3/"
},
"permissions": {
"href": "/example-org/datasources/3/permissions/"
},
"schema-sync": {
"href": "/example-org/datasources/3/schema-sync/"
}
}
}
HTTP status code 404
DataSource was not found.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
patch /{orgSlug}/datasources/{datasourceId}
Update the attributes of a Chartio datasource.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- datasourceId: required(integer)
The datasource identifier.
Body
Media type: application/json
Type: object
Properties- alias: (string)
The title of the datasource as displayed in the Chartio UI.
- last_refreshed_at: (datetime)
The datasource's last_refreshed_at time.
last_refreshed_at time must be specified using in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.ffffff+HH:MM[:SS[.ffffff]]) and must resolve to being within 10 minutes of the current time on the Chartio servers.
Data stored in the Chartio cache that was fetched prior to the last_refreshed_at time on a datasource will be considered invalid.
Example:
{
"alias": "Data Warehouse (Redshift)",
"last_refreshed_at": "2019-04-01T00:00:00Z"
}
HTTP status code 200
The datasource's last_refreshed_at time was updated.
Body
Media type: application/json
Type: object
Properties- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
- permissions: required(object)
A link to view or modify the user and team permissions for this datasource.
- href: required(string)
Example:
{ "permissions": { "href": "/example-org/datasources/3/permissions/" }, "schema-sync": { "href": "/example-org/datasources/3/schema-sync/" } }
- self: required(object)
- _embedded: (object)
- id: required(integer)
- alias: required(string)
- slug: required(string)
- dstype: required(string)
- created_at: required(datetime)
- updated_at: required(datetime)
- last_reflected: required(union of datetime or nil)
- last_refreshed_at: required(union of datetime or nil)
Example:
{
"id": 3,
"alias": "Data Warehouse",
"dstype": "Redshift",
"slug": "data-warehouse",
"created_at": "2019-03-04T00:00:00Z",
"updated_at": "2019-03-12T00:00:00Z",
"last_reflected": "2019-03-12T00:00:00Z",
"last_refreshed_at": null,
"_links": {
"self": {
"href": "/example-org/datasources/3/"
},
"permissions": {
"href": "/example-org/datasources/3/permissions/"
},
"schema-sync": {
"href": "/example-org/datasources/3/schema-sync/"
}
}
}
HTTP status code 400
Attempted to set a property to an invalid value.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
Create or modify a user or team permission on this datasource. If an existing permission for this datasource matches the user or team in the request, that permission will be updated instead of creating a new one.
The collection of user and team permissions for this datasource.
Permissions are limited to a default of 100 per datasource. If permissions are paginated, see the _links
metadata at the top level of the response for pagination links.
post /{orgSlug}/datasources/{datasourceId}/permissions
Create or modify a user or team permission on this datasource. If an existing permission for this datasource matches the user or team in the request, that permission will be updated instead of creating a new one.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- datasourceId: required(integer)
The datasource identifier.
Body
Media type: application/json
Possible types:
TeamPermissionNew
- access_level: required(one of editor, admin)
- team_id: required(integer)
UserPermissionNew
- user_id: required(integer)
- access_level: required(one of editor, admin)
Examples:
{
"user_id": 2,
"access_level": "admin"
}
{
"team_id": 1,
"access_level": "editor"
}
HTTP status code 200
Body
Media type: application/json
Type: object
HTTP status code 201
Body
Media type: application/json
Type: object
HTTP status code 400
Attempted to create a permission with a user or team which does not exist in the org, or an invalid permission value.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
get /{orgSlug}/datasources/{datasourceId}/permissions
The collection of user and team permissions for this datasource.
Permissions are limited to a default of 100 per datasource. If permissions are paginated, see the _links
metadata at the top level of the response for pagination links.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- datasourceId: required(integer)
The datasource identifier.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- _links: required(object)
A collection of links to related resources.
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
- next: (object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- previous: (object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
Example:
{ "self": { "href": "/example-org/items/?page=2" }, "next": { "href": "/example-org/items/?page=3" }, "previous": { "href": "/example-org/items/?page=1" } }
- self: required(object)
- _embedded: (object)
- count: required(integer)
- permissions: required(array of DataSourcePermissionResponse)
Items: DataSourcePermissionResponse
- _embedded: required(union of TeamEmbedded or UserEmbedded)
- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- id: required(integer)
- access_level: required(one of editor, admin)
Examples:
{ "_links": { "self": { "href": "/example-org/datasources/1/permissions/33/" } }, "_embedded": { "team": { "_links": { "self": { "href": "/example-org/teams/3/" } }, "id": 3, "name": "Marketing" } }, "id": "33,", "access_level": "editor" }
{ "_links": { "self": { "href": "/example-org/datasources/1/permissions/22/" } }, "_embedded": { "user": { "_links": { "self": { "href": "/example-org/users/2/" } }, "id": 2, "display_name": "Example User", "email": "user@example.com" } }, "id": "22,", "access_level": "admin" }
Example:
{
"_links": {
"self": {
"href": "/example-org/datasources/1/permissions/"
}
},
"count": "2,",
"permissions": [
{
"_links": {
"self": {
"href": "/example-org/datasources/1/permissions/33/"
}
},
"_embedded": {
"team": {
"_links": {
"self": {
"href": "/example-org/teams/3/"
}
},
"id": 3,
"name": "Marketing"
}
},
"id": 33,
"access_level": "editor"
},
{
"_links": {
"self": {
"href": "/example-org/datasources/1/permissions/22/"
}
},
"_embedded": {
"user": {
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"id": 2,
"display_name": "Example User",
"email": "user@example.com"
}
},
"id": 22,
"access_level": "admin"
}
]
}
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
Get an individual datasource permission.
Update a permission access level.
Update a permission access level.
get /{orgSlug}/datasources/{datasourceId}/permissions/{permissionId}
Get an individual datasource permission.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- datasourceId: required(integer)
The datasource identifier.
- permissionId: required(integer)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- _embedded: required(union of TeamEmbedded or UserEmbedded)
- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- id: required(integer)
- access_level: required(one of editor, admin)
Examples:
{
"_links": {
"self": {
"href": "/example-org/datasources/1/permissions/33/"
}
},
"_embedded": {
"team": {
"_links": {
"self": {
"href": "/example-org/teams/3/"
}
},
"id": 3,
"name": "Marketing"
}
},
"id": "33,",
"access_level": "editor"
}
{
"_links": {
"self": {
"href": "/example-org/datasources/1/permissions/22/"
}
},
"_embedded": {
"user": {
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"id": 2,
"display_name": "Example User",
"email": "user@example.com"
}
},
"id": "22,",
"access_level": "admin"
}
HTTP status code 404
Permission was not found.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
put /{orgSlug}/datasources/{datasourceId}/permissions/{permissionId}
Update a permission access level.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- datasourceId: required(integer)
The datasource identifier.
- permissionId: required(integer)
Body
Media type: application/json
Type: object
Properties- access_level: required(one of editor, admin)
Example:
{
"access_level": "admin"
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- _embedded: required(union of TeamEmbedded or UserEmbedded)
- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- id: required(integer)
- access_level: required(one of editor, admin)
Examples:
{
"_links": {
"self": {
"href": "/example-org/datasources/1/permissions/33/"
}
},
"_embedded": {
"team": {
"_links": {
"self": {
"href": "/example-org/teams/3/"
}
},
"id": 3,
"name": "Marketing"
}
},
"id": "33,",
"access_level": "editor"
}
{
"_links": {
"self": {
"href": "/example-org/datasources/1/permissions/22/"
}
},
"_embedded": {
"user": {
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"id": 2,
"display_name": "Example User",
"email": "user@example.com"
}
},
"id": "22,",
"access_level": "admin"
}
HTTP status code 400
An invalid access level was provided.
HTTP status code 404
Permission was not found.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
patch /{orgSlug}/datasources/{datasourceId}/permissions/{permissionId}
Update a permission access level.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- datasourceId: required(integer)
The datasource identifier.
- permissionId: required(integer)
Body
Media type: application/json
Type: object
Properties- access_level: required(one of editor, admin)
Example:
{
"access_level": "admin"
}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- _embedded: required(union of TeamEmbedded or UserEmbedded)
- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- id: required(integer)
- access_level: required(one of editor, admin)
Examples:
{
"_links": {
"self": {
"href": "/example-org/datasources/1/permissions/33/"
}
},
"_embedded": {
"team": {
"_links": {
"self": {
"href": "/example-org/teams/3/"
}
},
"id": 3,
"name": "Marketing"
}
},
"id": "33,",
"access_level": "editor"
}
{
"_links": {
"self": {
"href": "/example-org/datasources/1/permissions/22/"
}
},
"_embedded": {
"user": {
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"id": 2,
"display_name": "Example User",
"email": "user@example.com"
}
},
"id": "22,",
"access_level": "admin"
}
HTTP status code 400
An invalid access level was provided.
HTTP status code 404
Permission was not found.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
delete /{orgSlug}/datasources/{datasourceId}/permissions/{permissionId}
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- datasourceId: required(integer)
The datasource identifier.
- permissionId: required(integer)
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
Initiate a schema sync for this datasource. This will contact your database and compare the remote schema with your local Chartio schema. Any new tables and columns that are discovered will be added to your Chartio schema, while any tables or columns that no longer exist will be marked as such.
No charts will be modified when performing a sync.
This process is asynchronous and will take a minute or so to complete. Requests that take longer than 15 minutes will be considered an error. Clients initiating a schema sync will receive a response with a Location header which they can poll to see the status of the sync.
post /{orgSlug}/datasources/{datasourceId}/schema-sync
Initiate a schema sync for this datasource. This will contact your database and compare the remote schema with your local Chartio schema. Any new tables and columns that are discovered will be added to your Chartio schema, while any tables or columns that no longer exist will be marked as such.
No charts will be modified when performing a sync.
This process is asynchronous and will take a minute or so to complete. Requests that take longer than 15 minutes will be considered an error. Clients initiating a schema sync will receive a response with a Location header which they can poll to see the status of the sync.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- datasourceId: required(integer)
The datasource identifier.
HTTP status code 202
Headers
- Location: required(string)
URL pointing to newly created team.
Example:
/example-org/datasource/1/schema-sync/tasks/abcdefab-abcd-abcd-abcd-abcdefabcdef
Body
Media type: application/json
Type: object
Properties- task_id: required(string)
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
Poll for the status of a schema refresh task. This is for clients to understand whether a schema sync has succeeded or failed.
Task status is not persistent, and the task status will expire an hour after a job completes.
get /{orgSlug}/datasources/{datasourceId}/schema-sync/tasks/{taskId}
Poll for the status of a schema refresh task. This is for clients to understand whether a schema sync has succeeded or failed.
Task status is not persistent, and the task status will expire an hour after a job completes.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- datasourceId: required(integer)
The datasource identifier.
- taskId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- task_id: required(string)
HTTP status code 202
Body
Media type: application/json
Type: object
Properties- success: required(boolean)
- message: required(string)
- added_objects: required(object)
- num_columns: required(string)
- num_tables: required(string)
- num_schemas: required(string)
- num_foreign_keys: required(string)
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
Provides a listing of all teams within an org, as well as the ability to create new teams.
Create a new team.
The collection of teams belonging to this org.
Teams responses are paginated with a default of 100 teams per page. See the _links
metadata at the top level of the response for pagination links.
post /{orgSlug}/teams
Create a new team.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
Body
Media type: application/json
Type: object
Properties- name: required(string)
- id: (integer)
Example:
{
"name": "Sales"
}
HTTP status code 201
Headers
- Location: required(string)
URL pointing to newly created team.
Example:
/example-org/teams/1/
Body
Media type: application/json
Type: object
Properties- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- _embedded: (object)
- id: required(integer)
- name: required(string)
- is_owner: required(boolean)
- created_at: required(datetime)
- updated_at: required(datetime)
Example:
{
"id": 3,
"name": "Marketing",
"is_owner": false,
"created_at": "2018-10-04T00:00:00Z",
"updated_at": "2018-10-04T01:11:11Z",
"_links": {
"self": {
"href": "/example-org/teams/3/"
}
},
"_embedded": {
"users": [
{
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"id": 2,
"email": "marketing-user@example.com",
"display_name": "Marketing User"
}
]
}
}
HTTP status code 403
Orgs are limited to 2,000 teams.
HTTP status code 409
A team with the same name already exists.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
get /{orgSlug}/teams
The collection of teams belonging to this org.
Teams responses are paginated with a default of 100 teams per page. See the _links
metadata at the top level of the response for pagination links.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
HTTP status code 200
Returns a paginated list of teams. Each team's users are listed as nested resources within each team.
Body
Media type: application/json
Type: object
Properties- _links: required(object)
A collection of links to related resources.
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
- next: (object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- previous: (object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
Example:
{ "self": { "href": "/example-org/items/?page=2" }, "next": { "href": "/example-org/items/?page=3" }, "previous": { "href": "/example-org/items/?page=1" } }
- self: required(object)
- _embedded: (object)
- count: required(integer)
- teams: required(array of TeamResponse)
Items: TeamResponse
- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- _embedded: (object)
- id: required(integer)
- name: required(string)
- is_owner: required(boolean)
- created_at: required(datetime)
- updated_at: required(datetime)
Example:
{ "id": 3, "name": "Marketing", "is_owner": false, "created_at": "2018-10-04T00:00:00Z", "updated_at": "2018-10-04T01:11:11Z", "_links": { "self": { "href": "/example-org/teams/3/" } }, "_embedded": { "users": [ { "_links": { "self": { "href": "/example-org/users/2/" } }, "id": 2, "email": "marketing-user@example.com", "display_name": "Marketing User" } ] } }
- _links: required(object)
Example:
{
"count": 200,
"teams": [
{
"id": 4,
"name": "Sales",
"is_owner": false,
"created_at": "2018-10-04T00:00:00Z",
"updated_at": "2018-10-04T01:11:11Z",
"_links": {
"self": {
"href": "/example-org/teams/4/"
}
}
}
],
"_links": {
"self": {
"href": "/example-org/teams/"
},
"next": {
"href": "/example-org/teams/?page=2"
}
}
}
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
Provides methods for getting, modifying, and deleting a team.
Within the team resources, there are two teams with special properties:
- The Owners team. The Owners Team is included by default, and has global admin permissions for all account settings. The Owners team cannot be deleted or renamed and must always have at least one member. The {orgSlug}/teams/owners endpoint is provided as a convenience to access the Owners team.
- The "Added from Dashboard" team. This team is created when the first user is added to the organization via dashboard sharing. It includes all users which were initially added to the organization through sharing. This team cannot be deleted or renamed. Users cannot be added to it via the API, but can be removed.
Retrieves a team with all of its member users.
Rename a team. The Owners team cannot be renamed.
Delete a team. This does not delete the users which were members of this team. The owners team cannot be deleted.
get /{orgSlug}/teams/{teamId}
Retrieves a team with all of its member users.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- teamId: required(integer)
The team identifier.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- _embedded: (object)
- id: required(integer)
- name: required(string)
- is_owner: required(boolean)
- created_at: required(datetime)
- updated_at: required(datetime)
Example:
{
"id": 3,
"name": "Marketing",
"is_owner": false,
"created_at": "2018-10-04T00:00:00Z",
"updated_at": "2018-10-04T01:11:11Z",
"_links": {
"self": {
"href": "/example-org/teams/3/"
}
},
"_embedded": {
"users": [
{
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"id": 2,
"email": "marketing-user@example.com",
"display_name": "Marketing User"
}
]
}
}
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
patch /{orgSlug}/teams/{teamId}
Rename a team. The Owners team cannot be renamed.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- teamId: required(integer)
The team identifier.
Body
Media type: application/json
Type: object
Properties- id: (integer)
- name: (string)
Example:
{
"name": "Updated Team Name"
}
HTTP status code 200
The team was successfully renamed.
Body
Media type: application/json
Type: object
Properties- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- _embedded: (object)
- id: required(integer)
- name: required(string)
- is_owner: required(boolean)
- created_at: required(datetime)
- updated_at: required(datetime)
Example:
{
"id": 3,
"name": "Marketing",
"is_owner": false,
"created_at": "2018-10-04T00:00:00Z",
"updated_at": "2018-10-04T01:11:11Z",
"_links": {
"self": {
"href": "/example-org/teams/3/"
}
},
"_embedded": {
"users": [
{
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"id": 2,
"email": "marketing-user@example.com",
"display_name": "Marketing User"
}
]
}
}
HTTP status code 405
Attempted to modify the Owners or "Added from Dashboard" teams, which cannot be modified.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
delete /{orgSlug}/teams/{teamId}
Delete a team. This does not delete the users which were members of this team. The owners team cannot be deleted.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- teamId: required(integer)
The team identifier.
HTTP status code 204
The team was deleted.
HTTP status code 404
The team was not found.
HTTP status code 405
Attempted to delete the Owners or "Added from Dashboard" teams, which cannot be deleted.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
Write-only collection of users who are members of this team.
Add an existing user to this team. Users can be referenced by Chartio user id (preferred) or email. Users may change their email address, so emails are not guaranteed to be consistent identifiers.
patch /{orgSlug}/teams/{teamId}/users
Add an existing user to this team. Users can be referenced by Chartio user id (preferred) or email. Users may change their email address, so emails are not guaranteed to be consistent identifiers.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- teamId: required(integer)
The team identifier.
Body
Media type: application/json
Type: object
Properties- id: (integer)
An unique user identifier generated by Chartio when a user was created.
- email: (string)
The user's email address. This is not guaranteed to be a consistent identifier as users can change their email address.
Examples:
id:
{
"id": 2
}
email:
{
"email": "marketing-user@example.com"
}
HTTP status code 200
User was added to this team.
Body
Media type: application/json
Type: object
Properties- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- _embedded: (object)
- id: required(integer)
- name: required(string)
- is_owner: required(boolean)
- created_at: required(datetime)
- updated_at: required(datetime)
Example:
{
"id": 3,
"name": "Marketing",
"is_owner": false,
"created_at": "2018-10-04T00:00:00Z",
"updated_at": "2018-10-04T01:11:11Z",
"_links": {
"self": {
"href": "/example-org/teams/3/"
}
},
"_embedded": {
"users": [
{
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"id": 2,
"email": "marketing-user@example.com",
"display_name": "Marketing User"
}
]
}
}
HTTP status code 403
Orgs are limited to 10,000 users.
HTTP status code 405
Attempted to add a user to the "Added from Dashboard" team, which can only be modified by sharing a dashboard with a non-user from within the app.
HTTP status code 409
User is already a member of this team.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
Delete-only resource for an individual member of this team. Users can be referenced by Chartio user id (preferred) or email. Users may change their email address, so emails are not guaranteed to be consistent identifiers.
Remove a user from this team.
delete /{orgSlug}/teams/{teamId}/users/{userId}
Remove a user from this team.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- teamId: required(integer)
The team identifier.
- userId: required(union of UserId or UserEmailId)
Users can be referenced by either a Chartio user id (preferred), or an email address.
Chartio user ids are unique identifiers generated when a user was created.
Users' email addresses may change, so emails are not guaranteed to be consistent identifiers.
Examples:
id:
1
email:
user@example.com
HTTP status code 204
User was removed from this team.
HTTP status code 400
Users must belong to at least one team. Deleting the user from their only team is not allowed; delete the user instead. In addition, this response will also be returned when attempting to remove the last user from the owners team, which must always have at least one member.
HTTP status code 404
User was not a member of this team.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
A resource for the Owners team, which has admin capabilities within Chartio. The Owners team cannot be renamed or deleted.
Retrieves a team with all of its member users.
Rename a team. The Owners team cannot be renamed.
Delete a team. This does not delete the users which were members of this team. The owners team cannot be deleted.
get /{orgSlug}/teams/owners
Retrieves a team with all of its member users.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- _embedded: (object)
- id: required(integer)
- name: required(string)
- is_owner: required(boolean)
- created_at: required(datetime)
- updated_at: required(datetime)
Example:
{
"id": 3,
"name": "Marketing",
"is_owner": false,
"created_at": "2018-10-04T00:00:00Z",
"updated_at": "2018-10-04T01:11:11Z",
"_links": {
"self": {
"href": "/example-org/teams/3/"
}
},
"_embedded": {
"users": [
{
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"id": 2,
"email": "marketing-user@example.com",
"display_name": "Marketing User"
}
]
}
}
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
patch /{orgSlug}/teams/owners
Rename a team. The Owners team cannot be renamed.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
Body
Media type: application/json
Type: object
Properties- id: (integer)
- name: (string)
Example:
{
"name": "Updated Team Name"
}
HTTP status code 200
The team was successfully renamed.
Body
Media type: application/json
Type: object
Properties- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- _embedded: (object)
- id: required(integer)
- name: required(string)
- is_owner: required(boolean)
- created_at: required(datetime)
- updated_at: required(datetime)
Example:
{
"id": 3,
"name": "Marketing",
"is_owner": false,
"created_at": "2018-10-04T00:00:00Z",
"updated_at": "2018-10-04T01:11:11Z",
"_links": {
"self": {
"href": "/example-org/teams/3/"
}
},
"_embedded": {
"users": [
{
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"id": 2,
"email": "marketing-user@example.com",
"display_name": "Marketing User"
}
]
}
}
HTTP status code 405
Attempted to modify the Owners or "Added from Dashboard" teams, which cannot be modified.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
delete /{orgSlug}/teams/owners
Delete a team. This does not delete the users which were members of this team. The owners team cannot be deleted.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
HTTP status code 204
The team was deleted.
HTTP status code 404
The team was not found.
HTTP status code 405
Attempted to delete the Owners or "Added from Dashboard" teams, which cannot be deleted.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
Write-only collection of users who are members of this team.
Add an existing user to this team. Users can be referenced by Chartio user id (preferred) or email. Users may change their email address, so emails are not guaranteed to be consistent identifiers.
patch /{orgSlug}/teams/owners/users
Add an existing user to this team. Users can be referenced by Chartio user id (preferred) or email. Users may change their email address, so emails are not guaranteed to be consistent identifiers.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
Body
Media type: application/json
Type: object
Properties- id: (integer)
An unique user identifier generated by Chartio when a user was created.
- email: (string)
The user's email address. This is not guaranteed to be a consistent identifier as users can change their email address.
Examples:
id:
{
"id": 2
}
email:
{
"email": "marketing-user@example.com"
}
HTTP status code 200
User was added to this team.
Body
Media type: application/json
Type: object
Properties- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- _embedded: (object)
- id: required(integer)
- name: required(string)
- is_owner: required(boolean)
- created_at: required(datetime)
- updated_at: required(datetime)
Example:
{
"id": 3,
"name": "Marketing",
"is_owner": false,
"created_at": "2018-10-04T00:00:00Z",
"updated_at": "2018-10-04T01:11:11Z",
"_links": {
"self": {
"href": "/example-org/teams/3/"
}
},
"_embedded": {
"users": [
{
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"id": 2,
"email": "marketing-user@example.com",
"display_name": "Marketing User"
}
]
}
}
HTTP status code 403
Orgs are limited to 10,000 users.
HTTP status code 405
Attempted to add a user to the "Added from Dashboard" team, which can only be modified by sharing a dashboard with a non-user from within the app.
HTTP status code 409
User is already a member of this team.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
Delete-only resource for an individual member of this team. Users can be referenced by Chartio user id (preferred) or email. Users may change their email address, so emails are not guaranteed to be consistent identifiers.
Remove a user from this team.
delete /{orgSlug}/teams/owners/users/{userId}
Remove a user from this team.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- userId: required(union of UserId or UserEmailId)
Users can be referenced by either a Chartio user id (preferred), or an email address.
Chartio user ids are unique identifiers generated when a user was created.
Users' email addresses may change, so emails are not guaranteed to be consistent identifiers.
Examples:
id:
1
email:
user@example.com
HTTP status code 204
User was removed from this team.
HTTP status code 400
Users must belong to at least one team. Deleting the user from their only team is not allowed; delete the user instead. In addition, this response will also be returned when attempting to remove the last user from the owners team, which must always have at least one member.
HTTP status code 404
User was not a member of this team.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
Adds a new user to this org and add them to a team. Users must initially belong to a team when created.
The collection of users belonging to this org.
Users responses are paginated with a default of 100 teams per page. See the _links
metadata at the top level of the response for pagination links.
post /{orgSlug}/users
Adds a new user to this org and add them to a team. Users must initially belong to a team when created.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
Body
Media type: application/json
Type: object
Properties- email: required(string)
- team: required(object)
- id: required(integer)
Id of existing resource to be linked.
Example:
{ "id": 1 }
- id: required(integer)
Example:
{
"email": "new-user@example.com",
"team": {
"id": 1
}
}
HTTP status code 201
Headers
- Location: required(string)
URL pointing to newly created user.
Example:
/example-org/users/1/
Body
Media type: application/json
Type: object
Properties- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- _embedded: (object)
- id: required(integer)
- email: required(string)
- display_name: required(string)
- created_at: required(datetime)
- updated_at: required(datetime)
Example:
{
"id": 2,
"email": "user@example.com",
"display_name": "Example User",
"created_at": "2018-10-04T00:00:00Z",
"updated_at": "2018-10-04T00:00:00Z",
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"_embedded": {
"teams": [
{
"_links": {
"self": {
"href": "/example-org/teams/1/"
}
},
"id": 1,
"name": "Owners"
}
]
}
}
HTTP status code 400
An existing team must be provided.
HTTP status code 403
Orgs are limited to 10,000 users.
HTTP status code 409
User with matching email already exists in the org and on the specified team.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
get /{orgSlug}/users
The collection of users belonging to this org.
Users responses are paginated with a default of 100 teams per page. See the _links
metadata at the top level of the response for pagination links.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- _links: required(object)
A collection of links to related resources.
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
- next: (object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- previous: (object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
Example:
{ "self": { "href": "/example-org/items/?page=2" }, "next": { "href": "/example-org/items/?page=3" }, "previous": { "href": "/example-org/items/?page=1" } }
- self: required(object)
- _embedded: (object)
- count: required(integer)
- users: required(array of UserResponse)
Items: UserResponse
- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- _embedded: (object)
- id: required(integer)
- email: required(string)
- display_name: required(string)
- created_at: required(datetime)
- updated_at: required(datetime)
Example:
{ "id": 2, "email": "user@example.com", "display_name": "Example User", "created_at": "2018-10-04T00:00:00Z", "updated_at": "2018-10-04T00:00:00Z", "_links": { "self": { "href": "/example-org/users/2/" } }, "_embedded": { "teams": [ { "_links": { "self": { "href": "/example-org/teams/1/" } }, "id": 1, "name": "Owners" } ] } }
- _links: required(object)
Example:
{
"count": 200,
"_links": {
"self": {
"href": "/example-org/users/"
},
"next": {
"href": "/example-org/users/?page=2"
}
},
"users": [
{
"id": 2,
"email": "user@example.com",
"display_name": "Example User",
"created_at": "2018-10-04T00:00:00Z",
"updated_at": "2018-10-04T00:00:00Z",
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"_embedded": {
"teams": [
{
"_links": {
"self": {
"href": "/example-org/teams/1/"
}
},
"id": 1,
"name": "Owners"
}
]
}
}
]
}
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
Provides the capability to read, and delete individual users. {userId} can refer to either a Chartio user id (preferred), or an email address. Users' email addresses may change, so emails are not guaranteed to be consistent identifiers. Note that individual user data is read-only once created. Users can change their email address and display name within the app.
Gets a user.
Removes a user from all teams of a given organization. This does not delete a user from other organizations. Users that are the last member of the owners team cannot be removed from that organization.
get /{orgSlug}/users/{userId}
Gets a user.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- userId: required(union of UserId or UserEmailId)
Users can be referenced by either a Chartio user id (preferred), or an email address.
Chartio user ids are unique identifiers generated when a user was created.
Users' email addresses may change, so emails are not guaranteed to be consistent identifiers.
Examples:
id:
1
email:
user@example.com
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- _links: required(object)
- self: required(object)
A Hypertext Application Language (HAL) link. These links provide your API client with the location of related resources, such as paginated collections or nested objects, without the need to build URLs.
- href: required(string)
- curies: (array of HalCurie)
Items: HalCurie
- href: required(string)
- name: (string)
- templated: (boolean)
Example:
{ "self": { "href": "/example-org/items/" } }
- self: required(object)
- _embedded: (object)
- id: required(integer)
- email: required(string)
- display_name: required(string)
- created_at: required(datetime)
- updated_at: required(datetime)
Example:
{
"id": 2,
"email": "user@example.com",
"display_name": "Example User",
"created_at": "2018-10-04T00:00:00Z",
"updated_at": "2018-10-04T00:00:00Z",
"_links": {
"self": {
"href": "/example-org/users/2/"
}
},
"_embedded": {
"teams": [
{
"_links": {
"self": {
"href": "/example-org/teams/1/"
}
},
"id": 1,
"name": "Owners"
}
]
}
}
HTTP status code 404
User was not found.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.
delete /{orgSlug}/users/{userId}
Removes a user from all teams of a given organization. This does not delete a user from other organizations. Users that are the last member of the owners team cannot be removed from that organization.
Each request must contain the headers necessary for basic authentication.
URI Parameters
- orgSlug: required(string)
The Chartio organization slug.
- userId: required(union of UserId or UserEmailId)
Users can be referenced by either a Chartio user id (preferred), or an email address.
Chartio user ids are unique identifiers generated when a user was created.
Users' email addresses may change, so emails are not guaranteed to be consistent identifiers.
Examples:
id:
1
email:
user@example.com
HTTP status code 204
User was deleted.
HTTP status code 400
User was last member of the owners team.
HTTP status code 404
User was not found.
Secured by basicAuth
Headers
- Authorization: required(string)
Used to send the Base64-encoded "api_key:secret" credentials.
HTTP status code 401
Unauthorized. The provided api_key and secret combination is invalid.
HTTP status code 403
Forbidden. The api_key is not allowed to access the content provided by the requested URL.