Getting the Status of a Security Identity Provider

This is for:

In this article

Sample Request

You can also perform this action from the Coveo Administration Console (see Manage security identities).

Request template

GET https://platform.cloud.coveo.com/rest/organizations/<MyOrganizationId>/securityproviders/<MySecurityProviderId> HTTP/1.1
 
Content-Type: application/json
Accept: application/json
Authorization: Bearer <MyAccessToken>

In the request path:

Replace <MyOrganizationId> with the actual ID of the target Coveo organization (see Retrieve the organization ID).
Replace <MySecurityIdentityProviderId> with the actual ID of the target security identity provider.

In the Authorization HTTP header:

Replace <MyAccessToken> with an access token that grants the Security identity providers - View privilege in the target Coveo organization (see Create an API key, Get the privileges of an access token, and Get your Coveo access token).

The body of a successful response (200 OK) contains information about the target security identity provider.

Sample Request

Getting the status of a specific security identity provider

GET https://platform.cloud.coveo.com/rest/organizations/mycoveocloudv2organization/securityproviders/mypushsourcesecurityidentityprovider HTTP/1.1
 
Content-Type: application/json
Accept: application/json
Authorization: Bearer **********-****-****-****-************

Successful response - 200 OK

{
  "id": "mypushsourcesecurityidentityprovider",
  "name": "mypushsourcesecurityidentityprovider",
  "displayName": "mypushsourcesecurityidentityprovider",
  "organizationClusterId": "mycoveocloudv2organization-x3xz5hehgtdarowotab2oekcwa",
  "type": "EXPANDED",
  "nodeRequired": false,
  "caseSensitive": false,
  "parameters": {},
  "cascadingSecurityProviders": {
    "Email Security Provider": {
      "id": "Email Security Provider",
      "name": "Email Security Provider",
      "type": "EMAIL"
    }
  },
  "referencedBy": [
    {
      "type": "SOURCE",
      "id": "mycoveocloudv2organization-rp5rxzbdz753uhndklv2ztkfgy",
      "attributes": {
        "id": "mycoveocloudv2organization-rp5rxzbdz753uhndklv2ztkfgy",
        "name": "MyPushSource",
        "sourceType": "PUSH",
        "crawlerInstanceType": "Push",
        "pushEnabled": true,
        "onPremisesEnabled": false
      }
    }
  ],
  "statistics": {
    "numberOfEntitiesByState": {
      "UP_TO_DATE": 10,
      "DISABLED": 0,
      "NOT_UPDATED": 0,
      "OUT_OF_DATE": 0,
      "IN_ERROR": 0
    },
    "numberOfEntitiesInError": 0,
    "totalNumberOfEntities": 10
  },
  "lastRefreshOperation": {
    "operationType": "SECURITY_CACHE_REFRESH",
    "timestamp": 1513008128699,
    "numberOfEntitiesProcessed": 10
  },
  "currentStatus": {
    "type": "IDLE"
  }
}