Identity Broker REST API Reference

UnboundID Logo

/applicationgroups/{id}

Mount Point: /auth/api/v1/applicationgroups/{id}/

The following operations are supported on this resource:

GET

Retrieve a specified ApplicationGroup. Note there is no @Secured annotation on this method because there are no additional privileges needed to read ApplicationGroups. This endpoint is still secured via Spring Security and all requests will still go through the BrokerAuthenticationManager to make sure they have a valid OAuth token.

Parameters

name description type default
id The ID of the ApplicationGroup to be retrieved. path

Response Body

result: applicationGroup
media types: application/json

The requested ApplicationGroup retrieved.

Status Codes

code description
200 Success
304 Not modified
404 No such object

PUT

Updates an ApplicationGroup.

Parameters

name description type default
id The ID of the ApplicationGroup to be updated. path

Request Body

element: applicationGroup
media types: application/json

The updated state.

Response Body

result: applicationGroup
media types: application/json

ApplicationGroup updated application group.

Status Codes

code description
200 Success
412 Precondition failed
409 Reserved for cache object out of date

DELETE

Deletes the specified ApplicationGroup.

Parameters

name description type default
id The ID of the ApplicationGroup to be deleted. path

Status Codes

code description
204 Success
404 No such object