Agent Single Sign-On Config
You need Manage Security permission to set sso for a site.
Agent Single Sign-On
- Agent Single Sign-On Manage
GET global/agentSsoConfig
POST global/agentSsoConfig:disable
POST global/agentSsoConfig:enable
PUT global/agentSsoConfig
DELETE global/agentSsoConfig
Model
Agent Single Sign-On Config JSON Format
Agent Single Sign-On Config is represented as simple flat JSON objects with the following keys:
| Name | Type | Description |
|---|---|---|
siteId |
integer | Id of the site. |
isEnabled |
bool | Whether Agent Single Sign-On is enabled or not. |
protocolType |
string | Allowed values are "samlSso", "jwtSso". |
jwtLoginUrl |
string | JWT login url for remote authentication. Mandatory when the type is JWT SSO. |
jwtLogoutUrl |
string | Only available when type is jwtSso. |
samlCertificate |
string | SAML certificate, mandatory when type is samlSso. |
jwtSecret |
string | Token secret token. Mandatory when the type is JWT SSO. |
samlSSOUrl |
string | SAML login url for remote authentication. Mandatory when the type is SAML SSO. |
samlLogoutUrl |
string | Only available when type is samlSso. |
Endpoint
Get a single Agent Single Sign-On Config
GET global/agentSsoConfig
Example
Sample Request:
curl https://api15.comm100.io/v4/global/agentSsoConfig \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Disable the Agent Single Sign-On Config
POST global/agentSsoConfig:disable
Example
Sample Request:
curl https://api15.comm100.io/v4/global/agentSsoConfig:disable \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Enable the Agent Single Sign-On Config
POST global/agentSsoConfig:enable
Example
Sample Request:
curl https://api15.comm100.io/v4/global/agentSsoConfig:enable \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Update the Agent Single Sign-On Config
PUT global/agentSsoConfig
Parameters:
| Name | Type | In | Required | Description |
|---|---|---|---|---|
isEnabled |
bool | body | no | Whether Agent Single Sign-On is enabled or not. |
protocolType |
string | body | yes | Allowed values are "samlSso", "jwtSso". |
jwtLoginUrl |
string | body | yes | JWT login url for remote authentication. Mandatory when the type is JWT SSO. |
jwtLogoutUrl |
string | body | no | Only available when type is jwtSso. |
samlCertificate |
string | body | yes | SAML certificate, mandatory when type is samlSso. |
jwtSecret |
string | body | no | Token secret token. Mandatory when the type is JWT SSO. |
samlSSOUrl |
string | body | yes | SAML login url for remote authentication. Mandatory when the type is SAML SSO. |
samlLogoutUrl |
string | body | no | Only available when type is samlSso. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/global/agentSsoConfig \
-X
'PUT'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"isEnabled":true,"protocolType":"samlSso","jwtLoginUrl":"https://dash11.comm100.io/JWT/SSOLogin","jwtLogoutUrl":"https://dash11.comm100.io/JWT/SSOLogout","samlCertificate":"-----BEGIN CERTIFICATE-----\nMIIDqDCCApCgAwIBAgIGAXh4Z3tNMA0GCSqGSIb3DQEBCwUAMIGUMQswCQYDVQQGEwJVUzETMBEG\nA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEU\nMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGNvbW0xMDBtaWxhMjEcMBoGCSqGSIb3DQEJ\nARYNaW5mb0Bva3RhLmNvbTAeFw0yMTAzMjgxMDM0NTBaFw0zMTAzMjgxMDM1NTBaMIGUMQswCQYD\nVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsG\nA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxFTATBgNVBAMMDGNvbW0xMDBtaWxhMjEc\nMBoGCSqGSIb3DQEJARYNaW5mb0Bva3RhLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\nggEBAI08p+T38Q41bl1Uob0oak4q+5h0evb2PSSU2uwl6j/hdvaDTvH9tleZRYfBrTReVIi+CX9q\n2dH1i7DKejJmLx4yQR+d41NeNEyYZloz54q+8On2gxP+SknZhje8oiPKF+lMuW0KEOrLWScBYvcK\nSHVlMXM1u+lyrt6jw0P8Lh2Ga6irt4p8h6VcmIZLo8uQZSeRG8xqOVxhmiRC9rU4v1Hr50Lq6Cra\nRJvm9n7LVnigiZGjG6dW2jbPxYx8LyMKX3EuUr7ymvtoSSWwUHhWCQiaDksdu0q2R9oEalPYjqyh\n+1QeCEbmmm/drNeej8a8wcPlhWXfb+MCswSI6oEqxUsCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEA\nhBOnMO9jwqyd+DTToEpVknb0fP9fSzgrTfPWEFiozE/+R0oHXkcC2t2mUbfbvwt5NL9t5I7/q2bH\nLw/8FZgA0KmnFGIpTJd0kVeYysUfP9FJOgGz/63NgpmxrG8x3fxgOnY+TF+oYFkeGuDTwaejmlsV\nAzgLLbo1xN6mTMZ/FcQhnrg9nbaeUhaTQ0E5YbVNDo3qPFu58ZbqbljRTKHW4KdQ3FwVuDLrNimf\n1G7jb+8ySYD9xvdcbJgfTJVNyqSLn16i6s5z/vf5qzbiAf1gEP6dtjdH1ok1yZEOqdiFb6iJp/hi\nGfDTLRKSRwXQ4H1bEqdhQjLIn6kci02Dw2D8gg==\n-----END CERTIFICATE-----","jwtSecret":"NGE1NTI1NjAtZmRkNC00ZjA5LTgxMjctMjYwMmFlNmM4MjU5","samlSSOUrl":"https://dash11.comm100.io/SAML/SSOLogin","samlLogoutUrl":"https://dash11.comm100.io/SAML/SSOLogout"}'
Response:
HTTP/1.1 200 OK
Remove the Agent Single Sign-On Config
DELETE global/agentSsoConfig
Parameters:
No Parameters
Response:
No Content
Example
Sample Request:
curl https://api15.comm100.io/v4/global/agentSsoConfig \
-X
'DELETE'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 204 No Content