Return the current connection and runtime-copy validation state.

GET

/api/workspace/admin/external-identity

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://example.com/api/workspace/admin/external-identity"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/admin/external-identity';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/workspace/admin/external-identity \
  --header 'Authorization: Bearer <token>'

Authorizations

WorkspaceBearer

Parameters

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

200

application/json

Administrative projection of the current connection and runtime-copy validation.

object

Connection

Non-secret provider connection state exposed to administration and diagnostics.

object

string

nullable

ProviderKind

integer format: int32

Allowed values: 1 2

DisplayName

string

nullable

Issuer

string

nullable

AuthenticationClientId

string

nullable

DirectoryClientId

string

nullable

State

integer format: int32

Allowed values: 1 2 3

Health

integer format: int32

Allowed values: 1 2 3 4

Capabilities

Capabilities advertised by a configured external identity provider.

object

SupportsDirectorySearch

boolean

SupportsDirectoryBatchRead

boolean

SupportsProviderLogout

boolean

CreatedAtUtc

string format: date-time

LastValidatedAtUtc

string format: date-time

nullable

ArchivedAtUtc

string format: date-time

nullable

RuntimeConfigurationMatches

boolean

RuntimeDiagnosticCode

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12

Synchronization

Operational synchronization state for one provider connection.

object

ProviderConnectionId

string

nullable

Status

integer format: int32

Allowed values: 1 2 3 4

Health

integer format: int32

Allowed values: 1 2 3 4

LastAttemptAtUtc

string format: date-time

nullable

LastSuccessfulAtUtc

string format: date-time

nullable

NextScheduledAtUtc

string format: date-time

nullable

ConsecutiveFailureCount

integer format: int32

LastDiagnostic

Sanitized provider diagnostic safe for APIs and ordinary logs.

object

Code

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12

Message

string

nullable

LastCounters

Counters produced by one provider synchronization run.

object

CheckedIdentityCount

integer format: int32

ProfileChangeCount

integer format: int32

StatusChangeCount

integer format: int32

RevokedLocalTokenCount

integer format: int32

Example

{
  "Connection": {
    "ProviderKind": 1,
    "State": 1,
    "Health": 1
  },
  "RuntimeDiagnosticCode": 0,
  "Synchronization": {
    "Status": 1,
    "Health": 1,
    "LastDiagnostic": {
      "Code": 0
    }
  }
}