GET | /api/public/discovery | Return a list of services the user can login to. | If both CollectionGuid and SiteGuid are specified, they need to match (ie. the Collection must be within the Site). |
---|---|---|---|
POST | /api/public/discovery | Authenticate against all services and return a list of services the user can login to. | If both CollectionGuid and SiteGuid are specified, they need to match (ie. the Collection must be within the Site). |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ServiceGuid | body | Guid | No | If ServiceGuid is specified then the service to which the user can login is defined by it. |
CollectionGuid | body | Guid | No | If CollectionGuid is specified then the services to which the user can login are within that collection |
SiteGuid | body | Guid | No | if SiteGuid is specified then the services to which the user can login are within that site |
EmailAddress | body | String | Yes | |
Password | body | String | No | Password is required on POST. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Results | body | SSOUser[] | No | |
Count | body | Integer | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ServiceGuid | body | Guid | No | |
ServiceStatus | form | ServiceStatus | No | Allowable Values
|
ServiceName | form | string | No | |
ServiceCode | form | string | No | |
SsoEnabled | body | Boolean | No | Allowable Values
|
SsoProxyName | form | string | No | |
SsoProxyUrl | form | string | No | |
SsoProxyLogoutUrl | form | string | No | |
SsoProxyGuid | body | Guid | No | |
CollectionGuid | body | Guid | No | |
PrimaryDomain | form | string | No | |
Branding | form | Dictionary<string, string> | No | |
Urls | form | Dictionary<ServiceUrlType, string> | No | Allowable Values
|
Authenticators | form | List<Authenticator> | No | |
EmailAddress | form | string | No | |
IsAuthenticated | body | Boolean | No | Allowable Values
|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | body | String | No | |
Description | body | String | No | |
IdProviderGuid | body | Guid | No | |
IdPxLoginUrl | body | String | No | |
UsedLast | body | Boolean | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/public/discovery HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"serviceGuid": "00000000000000000000000000000000",
"collectionGuid": "00000000000000000000000000000000",
"siteGuid": "00000000000000000000000000000000",
"emailAddress": "String",
"password": "String"
}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length { "results": [ { "serviceGuid": "00000000000000000000000000000000", "serviceStatus": "Blocked", "serviceName": "String", "serviceCode": "String", "ssoEnabled": false, "ssoProxyName": "String", "ssoProxyUrl": "String", "ssoProxyLogoutUrl": "String", "ssoProxyGuid": "00000000000000000000000000000000", "collectionGuid": "00000000000000000000000000000000", "primaryDomain": "String", "branding": { "String": "String" }, "urls": { "MessagingApi": "String" }, "authenticators": [ { "name": "String", "description": "String", "idProviderGuid": "00000000000000000000000000000000", "idPxLoginUrl": "String", "usedLast": false } ], "emailAddress": "String", "isAuthenticated": false } ], "count": 0, "responseStatus": { "errorCode": "String", "message": "String", "stackTrace": "String", "errors": [ { "errorCode": "String", "fieldName": "String", "message": "String", "meta": { "String": "String" } } ], "meta": { "String": "String" } } }