Summary
Get all group mappings.
Description
Get all group mappings
Route
GET /group-mappings
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| queryOptions |
object |
yes |
The query options for searching group mappings. |
Copied to Clipboard
{
"queryOptions": {
"expand": "iapGroups",
"skip": 10,
"limit": 25,
"sort": "name",
"order": 1
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryOptions": {
"title": "queryOptions",
"type": "object",
"properties": {
"multiContains": {
"type": "object"
},
"multiEquals": {
"type": "object"
},
"multiStartsWith": {
"type": "object"
},
"expand": {
"type": "string",
"title": "List of fields to get expanded data",
"description": "Sets the fields to expand",
"examples": [
"iapGroups"
]
},
"skip": {
"$ref": "common-schema#/definitions/skip"
},
"limit": {
"$ref": "common-schema#/definitions/limit"
},
"sort": {
"$ref": "common-schema#/definitions/sort"
},
"order": {
"$ref": "common-schema#/definitions/order"
}
}
}
},
"required": [
"queryOptions"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
The group mappings matching the specified query. |
Copied to Clipboard
{
"results": {
"externalGroup": "proident consequat dolor",
"iapGroups": [
"Excepteur in",
"nisi labore laborum Excepteur enim"
],
"provenance": "Okta"
},
"total": 5
}
