Sso Settings Api List Sso Mappings
Returns a paginated collection of group mappings. q is a case-insensitive substring match on the IdP group. size is clamped to 1..100. sort accepts id, idpGroup, consoleRole or createdAt; any other property is 400 INVALID_SORT, and the default order is idpGroup ascending.
Case-insensitive substring search on the IdP group
alice
Zero-based page index (default: 0)
Number of items per page (default 20, 1 to 100). A value above 100 is clamped to 100, not rejected.
20
Sort spec in 'property,direction' format over id, idpGroup, consoleRole or createdAt (e.g. "idpGroup,desc")
idpGroup,asc
200 OK successful response envelope. A page of IdP group to console role mappings
{
"items": [
{
"id": 0,
"idpGroup": "string",
"consoleRole": "string",
"createdAt": "string"
}
],
"page": 0,
"pageSize": 0,
"totalItems": 0,
"totalPages": 0
}
Array of items for the current page
Zero-based current page number
Number of items requested per page
Total number of items matching filter criteria
Total number of available pages
400 Bad Request error response (INVALID_SORT)
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
403 Forbidden: FORBIDDEN when the signed-in role is not allowed to call this operation; PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/settings/sso/mappings