Summary
Get all SSO configurations
Description
Get all SSO configurations
Route
GET /sso/configs
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
queryOptions | object | yes | Options for query parameters. |
{ "queryOptions": { "contains": "GitHub", "containsField": "samlFirstNameAttribute", "equals": "Okta", "equalsField": "samlEmailAttribute", "startsWith": "Okta", "startsWithField": "samlUserNameAttribute", "skip": 50, "limit": 1, "sort": "name", "order": 1 } }
{ "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
Name | Type | Description |
---|---|---|
results | object | Contains an array of SSO configurations and the total in the response. |
{ "results": [ { "name": "Auth0", "ssoType": "saml", "settings": { "issuer": "https://www.auth0.com/oauth2/example", "loginURL": "https://www.auth0.com/login", "certificate": "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==", "samlUserNameAttribute": "user", "samlGroupsAttribute": "http://schemas.microsoft.com/ws/2008/06/identity/claims/groups", "forceLogin": false, "description": "This sso configuration connects to Okta", "logoutURL": "https://www.auth0.com/logout", "samlEmailAttribute": "email", "samlFirstNameAttribute": "http://schemas.microsoft.com/ws/2008/06/identity/claims/givenname" }, "tested": false }, { "name": "Okta", "ssoType": "saml", "settings": { "issuer": "https://www.auth0.com/oauth2/example", "loginURL": "https://www.auth0.com/login", "certificate": "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==", "samlUserNameAttribute": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name", "samlGroupsAttribute": "groups", "forceLogin": false, "description": "This sso configuration connects to Okta", "logoutURL": "https://www.auth0.com/logout", "samlEmailAttribute": "mail", "samlFirstNameAttribute": "http://schemas.microsoft.com/ws/2008/06/identity/claims/givenname" }, "tested": true }, { "name": "Auth0", "ssoType": "saml", "settings": { "issuer": "https://www.auth0.com/oauth2/example", "loginURL": "https://www.auth0.com/login", "certificate": "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==", "samlUserNameAttribute": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name", "samlGroupsAttribute": "groups", "forceLogin": false, "description": "This sso configuration connects to Okta", "logoutURL": "https://www.auth0.com/logout", "samlEmailAttribute": "email", "samlFirstNameAttribute": "name" }, "tested": true }, { "name": "Okta", "ssoType": "saml", "settings": { "issuer": "https://www.auth0.com/oauth2/example", "loginURL": "https://www.auth0.com/login", "certificate": "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==", "samlUserNameAttribute": "username", "samlGroupsAttribute": "http://schemas.microsoft.com/ws/2008/06/identity/claims/groups", "forceLogin": false, "description": "This sso configuration connects to Okta", "logoutURL": "https://www.auth0.com/logout", "samlEmailAttribute": "email", "samlFirstNameAttribute": "http://schemas.microsoft.com/ws/2008/06/identity/claims/givenname" }, "tested": true }, { "name": "Okta", "ssoType": "saml", "settings": { "issuer": "https://www.auth0.com/oauth2/example", "loginURL": "https://www.auth0.com/login", "certificate": "MIIDrjCCApagAwIBAgIGAYbHI140MA0GCSqGSIb3DQEBCwUAMIGXMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU==", "samlUserNameAttribute": "user", "samlGroupsAttribute": "groups", "forceLogin": false, "description": "This sso configuration connects to Okta", "logoutURL": "https://www.auth0.com/logout", "samlEmailAttribute": "mail", "samlFirstNameAttribute": "http://schemas.microsoft.com/ws/2008/06/identity/claims/givenname" }, "tested": false } ], "total": 10 }
{ "title": "results", "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "sso-schema" } }, "total": { "$ref": "common-schema#/definitions/total" } } }