Groups

Managing Conformity groups.

List All Groups

get/groups

This endpoint allows you to query all groups with accounts that you have access to.

SecurityApiKeyAuth
Responses
200

OK

401

Unauthorized.

403

Unauthorized. The requesting user does not have enough privilege.

Response samples
application/json
{
  • "data": [
    ]
}

Create Group

post/groups

This endpoint allows an ADMIN user to create a new group.

SecurityApiKeyAuth
Request
Request Body schema: application/vnd.api+json
required
object
Responses
200

OK

401

Unauthorized.

403

Unauthorized. The requesting user does not have enough privilege.

422

Unprocessable Entity. It happens when there is a validation error.

Request samples
application/vnd.api+json
{
  • "data": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

Get Group Details

get/groups/{groupId}

This endpoint allows you to get the details of the specified group with accounts that you have access to.

SecurityApiKeyAuth
Request
path Parameters
groupId
required
string

The Cloud Conformity ID of the group.

Responses
200

OK

401

Unauthorized.

403

Unauthorized. The requesting user does not have enough privilege.

Response samples
application/json
{
  • "data": [
    ]
}

Delete Group

delete/groups/{groupId}

A DELETE request to this endpoint allows an ADMIN to delete the specified group.

SecurityApiKeyAuth
Request
path Parameters
groupId
required
string

The Cloud Conformity ID of the group.

Responses
200

OK

401

Unauthorized.

403

Unauthorized. The requesting user does not have enough privilege.

Response samples
application/json
{
  • "meta": {
    }
}

Update Group

patch/groups/{groupId}

This endpoint allows an ADMIN user to update a new group.

SecurityApiKeyAuth
Request
path Parameters
groupId
required
string

The Cloud Conformity ID of the group.

Request Body schema: application/vnd.api+json
required
object
Responses
200

OK

401

Unauthorized.

403

Unauthorized. The requesting user does not have enough privilege.

422

Unprocessable Entity. It happens when there is a validation error.

Request samples
application/vnd.api+json
{
  • "data": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}