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)

# Group APIs

The following APIs can be used to interact with groups in a multi-tenant implementation of the Platform, and their associated grants, users, and devices.

# GET Query Groups

# /groups

# Parameters

Name Located in Description Required Schema
IDs query Search by ids No [ string ]
name query Search by name No string
tags query Search by one or more tags No [ string ]
tenantId query Search by a tenant ID that owns this principal No string
user query No string
device query No string
grantId query Search by a grant ID that this group has No string
limit query Limit the number of returned values No integer

# Responses

Code Description Schema
200 Success ListResponse.Group
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 New Group

# /groups

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
404 Not found. One or more resources were not found, response may contain details about missing resources ServiceErrors
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 Group by ID

# /groups/{groupId}

# Parameters

Name Located in Description Required Schema
groupId path Group identifier Yes string

# Responses

Code Description Schema
200 Success Group
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 Group

# /groups/{groupId}

# Parameters

Name Located in Description Required Schema
groupId path Group identifier Yes string

# 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
404 Not found. One or more resources were not found, response may contain details about missing resources ServiceErrors
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

# DELETE Delete a Group

# /groups/{groupId}

# Parameters

Name Located in Description Required Schema
groupId path Group 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

# GET Query Grants of this Group

# /groups/{groupId}/grants/{scope}

# Parameters

Name Located in Description Required Schema
groupId path Group identifier Yes string
scope path Yes string

# Responses

Code Description Schema
200 Success ListResponse.Grant
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 Assign a Grant

NOTE

This endpoint is idempotent

# /groups/{groupId}/grants/{scope}/{grantId}

# Parameters

Name Located in Description Required Schema
groupId path Group identifier Yes string
scope path Yes string
grantId path Grant 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 Revoke a Grant

NOTE

This endpoint is idempotent

# /groups/{groupId}/grants/{scope}/{grantId}

# Parameters

Name Located in Description Required Schema
groupId path Group identifier Yes string
scope path Yes string
grantId path Grant 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 a User as a Member

NOTE

This endpoint is idempotent

# /groups/{groupId}/users/{userId}

# Parameters

Name Located in Description Required Schema
groupId path Group identifier Yes string
userId path User 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 Remove a User from a Group

# /groups/{groupId}/users/{userId}

# Parameters

Name Located in Description Required Schema
groupId path Group identifier Yes string
userId path User 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 a Device as a Member

NOTE

This endpoint is idempotent

# /groups/{groupId}/devices/{deviceId}

# Parameters

Name Located in Description Required Schema
groupId path Group identifier Yes string
deviceId path Device 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 Remove a Device from a Group

# /groups/{groupId}/devices/{deviceId}

# Parameters

Name Located in Description Required Schema
groupId path Group identifier Yes string
deviceId path Device 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
Last updated: 1/10/2022, 11:05:26 AM

← Identity Providers →

Feedback