List the groups known to the identity provider.

GET 
/v1/groups

Returns every group in the realm. Use name when granting a group access in a permission set.

Request

Header Parameters

Authorization string

Responses

200

Groups known to the identity provider.

application/json

Schema

Schema

• Array [

id stringrequired

Possible values: non-empty

Identifier of the group.

name stringrequired

Possible values: non-empty

Name of the group. This is the value used to grant a group access in a permission set.

• ]

Example (from schema)

[
  {
    "id": "string",
    "name": "string"
  }
]

401

Unauthorized. This error will occur if calling user does not have access right for the API.

403

Forbidden. This error will occur if the user lacks the proper roles or permissions to perform this action.

500

A server error occurred. Check the logs for more details.

Loading...