Summary
Get all SSO configurations
Description
Get all SSO configurations
Route
GET /sso/configs
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| queryOptions |
object |
yes |
Options for query parameters. |
Copied to Clipboard
{
"queryOptions": {
"contains": "GitHub",
"containsField": "name",
"equals": "Okta",
"equalsField": "ssoType",
"startsWith": "Okta",
"startsWithField": "name",
"skip": 10,
"limit": 50,
"sort": "name",
"order": 1
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryOptions": {
"title": "queryOptions",
"type": "object",
"properties": {
"contains": {
"type": "string",
"examples": [
"GitHub"
]
},
"containsField": {
"type": "string",
"enum": [
"name",
"samlEmailAttribute",
"samlUserNameAttribute",
"samlGroupsAttribute",
"samlFirstNameAttribute",
"ssoType"
]
},
"equals": {
"type": "string",
"examples": [
"Okta"
]
},
"equalsField": {
"type": "string",
"enum": [
"name",
"samlEmailAttribute",
"samlUserNameAttribute",
"samlGroupsAttribute",
"samlFirstNameAttribute",
"ssoType"
]
},
"startsWith": {
"type": "string",
"examples": [
"Okta"
]
},
"startsWithField": {
"type": "string",
"enum": [
"name",
"samlEmailAttribute",
"samlUserNameAttribute",
"samlGroupsAttribute",
"samlFirstNameAttribute",
"ssoType"
]
},
"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 |
| results |
object |
Contains an array of SSO configurations and the total in the response. |
Copied to Clipboard
{
"results": [
{
"name": "Auth0",
"ssoType": "saml",
"settings": {
"issuer": "https://www.auth0.com/oauth2/example",
"loginURL": "https://www.auth0.com/login",
"certificate": "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==",
"samlUserNameAttribute": "username",
"samlGroupsAttribute": "groups",
"forceLogin": false,
"description": "This sso configuration connects to Okta",
"logoutURL": "https://www.auth0.com/logout",
"samlEmailAttribute": "mail",
"samlFirstNameAttribute": "name"
},
"tested": true
}
],
"total": 10
}
