Sso Settings Api List Sso Mappings

Sso Settings Api List Sso Mappings
List IdP group mappings (Administrator only)

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.

Request
URI
GET
https://{api_host}/api/v1/settings/sso/mappings
COPY
Query Parameters
string
q
Optional

Case-insensitive substring search on the IdP group

q example
alice
integer
page
Optional
Constraints: minimum: 0 default: 0

Zero-based page index (default: 0)

integer
size
Optional
Constraints: minimum: 1 maximum: 100 default: 20

Number of items per page (default 20, 1 to 100). A value above 100 is clamped to 100, not rejected.

size example
20
string
sort
Optional

Sort spec in 'property,direction' format over id, idpGroup, consoleRole or createdAt (e.g. "idpGroup,desc")

sort example
idpGroup,asc

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. A page of IdP group to console role mappings

Returns PaginatedResponse_SsoGroupMapping of type(s) application/json
{
    "items": [
        {
            "id": 0,
            "idpGroup": "string",
            "consoleRole": "string",
            "createdAt": "string"
        }
    ],
    "page": 0,
    "pageSize": 0,
    "totalItems": 0,
    "totalPages": 0
}
array of object
items
Required  

Array of items for the current page

integer As int32 As int32
page
Required  
Constraints: minimum: 0

Zero-based current page number

integer As int32 As int32
pageSize
Required  
Constraints: minimum: 1 maximum: 100

Number of items requested per page

integer As int64 As int64
totalItems
Required  

Total number of items matching filter criteria

integer As int32 As int32
totalPages
Required  
Constraints: minimum: 0

Total number of available pages


400

400 Bad Request error response (INVALID_SORT)

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

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)

Returns ForbiddenRead of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/settings/sso/mappings