Get True SSO Monitor Info

Get True SSO Monitor Info

Gets monitoring information related to a True SSO connector.

Request
URI
GET
https://{api_host}//localhost/rest/monitor/v1/true-sso/{id}
COPY
Path Parameters
string
id
Required

id

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns TrueSSOMonitorInfo of type(s) */* 
{
    "ad_domain_dns_name": "ad-domain.example.com",
    "ad_domain_id": "S-1-5-21-1085031214-1563985344-725345543",
    "ad_domain_status": "OK",
    "certificate_server_details": [
        {
            "name": "SSOConnector",
            "status": "OK"
        }
    ],
    "enabled": true,
    "id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
    "name": "true-sso.example.com",
    "primary_enrollment_server": {
        "dns_name": "enrollment-server.example.com",
        "id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
        "status": "OK"
    },
    "secondary_enrollment_server": {
        "dns_name": "enrollment-server.example.com",
        "id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
        "status": "OK"
    },
    "status": "OK",
    "template_name": "TrueSSO Template",
    "template_status": "OK"
}
string
ad_domain_dns_name
Optional

The DNS name of the domain.

string
ad_domain_id
Optional

Unique SID of the AD Domain.

string
ad_domain_status
Optional

The state of the domain health, taken as the most severe reported by one of the enrollment servers.

  • OK: The state of the domain is OK as reported by the enrollment servers.
  • WARN: At least one of the enrollment servers has a warning.
  • ERROR: At least one of the enrollment servers is in an error state.
Possible values are : OK, WARN, ERROR,
array of CertificateServerDetails
certificate_server_details
Optional

Details of each certificate server.

boolean
enabled
Optional

Indicates if the True SSO connector is enabled.

string
id
Optional

Unique ID of the True SSO Connector.

string
name
Optional

True SSO connector name.

EnrollmentServerDetails
primary_enrollment_server
Optional

primary_enrollment_server

EnrollmentServerDetails
secondary_enrollment_server
Optional

secondary_enrollment_server

string
status
Optional

Overall status of the True SSO connector.

  • OK: All the components of the True SSO connector are fine.
  • WARN: At least one component of the True SSO connector has a warning.
  • ERROR: At least one component of the True SSO connector has an error.
Possible values are : OK, WARN, ERROR,
string
template_name
Optional

Unique name for the True SSO template.

string
template_status
Optional

The state of the template health, taken as the most severe reported by one of the enrollment servers.

  • OK: The state of the template is OK as reported by the enrollment servers.
  • WARN: At least one enrollment server reports a warning on this template.
  • ERROR: At least one enrollment server reports an error on this template.
Possible values are : OK, WARN, ERROR,

401

User is not authenticated

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page
Monitor Operations
GET
Get Connection Server Monitor Info V2
GET
Get Event Database Monitor
GET
Get Farm Monitor Info
GET
Get Gateway Monitor Info
GET
Get Pod Monitor Info V2
GET
Get RDS Server Monitors
GET
Get SAML Authenticator Monitor Info
GET
Get True SSO Monitor Info
GET
Get View Composer By VC Id
GET
Get Virtual Center Monitor Info
GET
List AD Domain Monitor Infos V2
GET
List AD Domain Monitor Infos V3
GET
List AD Domain Monitors
GET
List Connection Server Monitors
GET
List Connection Server Monitors V2
GET
List Desktop Pool Metrics
GET
List Farm Monitors
GET
List Gateway Monitor Info V1
GET
List Gateway Monitor Info V2
GET
List Pod Monitor Infos V1
GET
List Pod Monitor Infos V2
GET
List RDS Server Monitors
GET
List SAML Authenticator Monitors V1
GET
List SAML Authenticator Monitors V2
GET
List True SSO Monitor Infos
GET
List View Composer Monitors V1
GET
List View Composer Monitors V2
GET
List Virtual Center Monitors
GET
List Virtual Center Monitors V2