Ability™ Developer Portal v23.1
Try Sandbox for free
Get a month of free access to ABB Ability™ Platform to learn and experiment!
API Playground
Play with ABB Ability™ Platform APIs (no time limits)

# Tenant APIs

The following APIs can be used to interact with tenants in a multi-tenant implementation of the Platform.

# GET Query Tenants

# /tenants

# Parameters

Name Located in Description Required Schema
name query Search by name No string
tags query Search by one or more tags No [string]
identityProviderId query Search by identity provider identifiers authorized by this tenant No string
limit query Limit the number of returned values No integer
sort query Sort the results ("name asc" or "name desc") No string
page query Must be a positive number, default value is 1 No integer

# Responses

Code Description Schema
200 Success ListResponse.Tenant
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors

# POST Create a Tenant

# /tenants

# Responses

Code Description Schema
201 Resource created InlineResponse201
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
409 Conflict ServiceErrors
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors

# GET Get a Tenant

# /tenants/{tenantId}

# Parameters

Name Located in Description Required Schema
tenantId path Tenant identifier Yes string

# Responses

Code Description Schema
200 Success Tenant
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
404 Not found. One or more resources were not found, response may contain details about missing resources ServiceErrors
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors

# GET Get a B2C Tenant ID

# /b2c/tenant?tenantName={name}

# Parameters

Name Located in Description Required Schema
tenantName path Tenant's name Yes string

# Responses

Code Description Schema
200 Success Tenant
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
404 Not found. One or more resources were not found, response may contain details about missing resources ServiceErrors
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors

# PUT Update a Tenant

# /tenants/{tenantId}

# Parameters

Name Located in Description Required Schema
tenantId path Tenant identifier Yes string

# Responses

Code Description Schema
204 Success
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
404 Not found. One or more resources were not found, response may contain details about missing resources ServiceErrors
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors

# DELETE Delete a Tenant

# /tenants/{tenantId}

# Parameters

Name Located in Description Required Schema
tenantId path Tenant identifier Yes string

# Responses

Code Description Schema
204 Success
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
404 Not found. One or more resources were not found, response may contain details about missing resources ServiceErrors
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors

# PUT Authorize and Configure an Identity Provider

# /tenants/{tenantId}/identityProviders/{ipId}

# Parameters

Name Located in Description Required Schema
tenantId path Tenant identifier Yes string
ipId path Identity provider identifier Yes string

# Responses

Code Description Schema
204 Success
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
404 Not found. One or more resources were not found, response may contain details about missing resources ServiceErrors
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors

# DELETE Unauthorize an Identity Provider

# /tenants/{tenantId}/identityProviders/{ipId}

# Parameters

Name Located in Description Required Schema
tenantId path Tenant identifier Yes string
ipId path Identity provider identifier Yes string

# Responses

Code Description Schema
204 Success
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
404 Not found. One or more resources were not found, response may contain details about missing resources ServiceErrors
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors

# PUT Add or Replace a Group Mapping in an Identity Provider

# /tenants/{tenantId}/identityProviders/{ipId}/groups/{from}/{to}

# Parameters

Name Located in Description Required Schema
tenantId path Tenant identifier Yes string
ipId path Identity provider identifier Yes string
from path Identity provider group ID Yes string
to path Ability group ID Yes string

# Responses

Code Description Schema
204 Success
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
404 Not found. One or more resources were not found, response may contain details about missing resources ServiceErrors
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors

# DELETE Remove a Group Mapping in an Identity Provider

# /tenants/{tenantId}/identityProviders/{ipId}/groups/{from}

# Parameters

Name Located in Description Required Schema
tenantId path Tenant identifier Yes string
ipId path Identity provider identifier Yes string
from path Identity provider group ID Yes string

# Responses

Code Description Schema
204 Success
400 Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc ServiceErrors
401 Not Authorized. Either the Access token is missing or the access token validation failed
403 Access Forbidden. Requesting entity does not have enough permissions to access the resource
404 Not found. One or more resources were not found, response may contain details about missing resources ServiceErrors
429 Too many requests - indicates the user has sent too many requests in a given amount of time
500 Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors ServiceErrors
Last updated: 2/11/2022, 12:49:51 PM

← Users →

Feedback