Checks the current user's exact enrollment without returning its code or device credentials.

GET

/api/workspace/file-protection/agents/enrollments/{enrollmentId}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://example.com/api/workspace/file-protection/agents/enrollments/example"),
    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/file-protection/agents/enrollments/example';
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/file-protection/agents/enrollments/example \
  --header 'Authorization: Bearer <token>'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

enrollmentId

required

string

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

object

Data

Safe connection progress for the requesting user’s exact enrollment; never contains credentials.

object

ExpiresAtUtc

string format: date-time

IsExpired

boolean

IsRevoked

boolean

Agent

Safe state of one enrolled backup Agent.

object

string

nullable

DisplayName

string

nullable

OperatingSystem

Operating systems supported by the universal File Protection tools.

integer format: int32

Allowed values: 0 1

AgentVersion

string

nullable

State

Lifecycle state reported for an enrolled Agent.

integer format: int32

Allowed values: 0 1 2 3

LastHeartbeatAtUtc

string format: date-time

nullable

SourceCount

integer format: int32

RowVersion

string format: uuid

SignalSummary

Compact active signal summary for object grids.

object

Count

integer format: int32

Severity

integer format: int32

Allowed values: 1 2

PolicyKinds

Array<integer>

nullable

Allowed values: 0 1 2 3 4 5

Conditions

Array<object>

nullable

Exact active type/severity association for combined grid filters.

object

PolicyKind

integer format: int32

Allowed values: 0 1 2 3 4 5

Severity

integer format: int32

Allowed values: 1 2

Count

integer format: int32

RequiredAgentVersion

Required Agent software for the current installation instructions.

string

nullable

RequiresUpdate

Connection availability does not establish software compatibility.

boolean

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Agent": {
      "OperatingSystem": 0,
      "State": 0,
      "SignalSummary": {
        "Severity": 1,
        "PolicyKinds": [
          0
        ],
        "Conditions": [
          {
            "PolicyKind": 0,
            "Severity": 1
          }
        ]
      }
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}