List of user groups

GET 
/seb-api/v1/user-groups

Retrieve a list of user groups.

Request

Query Parameters

limit int32

Number of user requests to return.

cursor string

An optional opaque string that defines from where to start listing.

Responses

200

A list of user groups

application/json

Schema

Schema

data object[]
Array [
createdAt date-time
Created at
id stringrequired
Unique identifier
lastUpdated date-time
Last updated
name stringrequired
Name
provider string
Possible values: [sso, local]
Provider
]
pageInfo object

cursor stringnullable

When paginating forwards, the cursor to continue.

hasNextPage booleanrequired

When paginating forwards, are there more items?

Example (from schema)

{
  "data": [
    {
      "createdAt": "2024-07-29T15:51:28.071Z",
      "id": "string",
      "lastUpdated": "2024-07-29T15:51:28.071Z",
      "name": "string",
      "provider": "sso"
    }
  ],
  "pageInfo": {
    "cursor": "string",
    "hasNextPage": true
  }
}

400

Bad request

application/json

Schema

Schema

errorResponse object
error string
message stringrequired

Example (from schema)

{
  "errorResponse": {
    "error": "string",
    "message": "string"
  }
}

403

Forbidden

500

Internal server error

Loading...