An OPA Client corresponds to a specific device. Clients are the primary way Users access OPA resources.
Returns a list of Clients for your Team. By default, this only returns Clients associated with the requesting User. Use query parameters to adjust the list of returned Clients.
This endpoint requires one of the following roles: end_user
, security_admin
, resource_admin
.
OK
{- "list": [
- {
- "id": "9c199afe-0ca5-427a-baac-c4341707d82b",
- "user_name": "Jason.Compson.IV",
- "description": "Work laptop",
- "hostname": "LightInAugust",
- "os": "macOS 10.14.6",
- "encrypted": true,
- "deleted_at": null,
- "state": "PENDING"
}, - {
- "id": "5e9d8179-2fca-4905-8405-3cd3e0c5280e",
- "user_name": "Jason.Compson.IV",
- "description": "Personal laptop",
- "hostname": "Absalom",
- "os": "macOS 10.14.6",
- "encrypted": true,
- "deleted_at": null,
- "state": "ACTIVE"
}
]
}
Retrieves the properties of a specified Client
This endpoint requires one of the following roles: end_user
, security_admin
, resource_admin
.
OK
{- "deleted_at": null,
- "description": "Work laptop",
- "encrypted": true,
- "hostname": "LightInAugust",
- "id": "9c199afe-0ca5-427a-baac-c4341707d82b",
- "os": "macOS 10.14.6",
- "state": "PENDING",
- "user_name": "Jason.Compson.IV"
}
Updates the state or assigned user for a specified Client. This is required for some enrollment policies. See Silently enroll the Client.
This endpoint requires the following role: resource_admin
.
No Content
{- "state": "ACTIVE",
- "user_name": "Jason.Compson.IV"
}
Revokes access to a specified Client from your Team
This endpoint requires one of the following roles: end_user
, security_admin
, resource_admin
.
No Content