Skip to main content
POST
/
api
/
admin
/
ssoProviders
List SSO providers
curl --request POST \
  --url https://pria.praxislxp.com/api/admin/ssoProviders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "institution": "<string>",
  "page": 1,
  "pageSize": 100
}
'
{
  "success": true,
  "data": [
    {
      "_id": "<string>",
      "institution": "<string>",
      "slug": "my-university",
      "label": "<string>",
      "enabled": true,
      "clientId": "<string>",
      "clientSecret": "<string>",
      "tokenHost": "https://id.provider.com:443",
      "tokenPath": "/oauth2/token",
      "authorizePath": "/oauth2/authorize",
      "userinfoUrl": "https://id.provider.com:443/oauth2/userinfo",
      "scope": "openid",
      "fieldMapping": {
        "email": "email",
        "firstName": "given_name",
        "lastName": "family_name"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "hasMore": true,
  "page": 123,
  "pageSize": 123,
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

JWT token passed in authorization header

Body

application/json
institution
string

Filter by institution ID

page
integer
default:1

Page number (1-based)

Required range: x >= 1
pageSize
integer
default:100

Number of results per page

Required range: 1 <= x <= 5000

Response

List of SSO providers

success
boolean

Request success status

data
object[]

Array of SSO provider objects

total
integer

Total number of matching providers

hasMore
boolean

Whether more results are available

page
integer

Current page number

pageSize
integer

Number of results per page

message
string

Response message