Persons
Persons API overview
The Persons API allows integrators to manage person records within SCM.
The API supports the following actions:
- Creating persons
- Listing persons
- Updating persons
- Sending enrollment invitations
- Viewing available enrollment endpoints and accounts
- Importing private keys for a person
Persons API endpoints
The following tables group the Persons API endpoints by functionality.
Click any action in the first column to open its API reference page.
Click any action in the first column to open its API reference page.
1. Person listing & lookup
| Action | Method | Path | Description |
|---|---|---|---|
| List persons | GET | /api/person/v2 | List persons with optional filters. |
| Get a person by ID | GET | /api/person/v2/{id} | Retrieve details for a specific person by ID. |
| Get a person ID by email | GET | /api/person/v2/id/byEmail/{email} | Look up a person ID using an email address. |
2. Person creation & maintenance
| Action | Method | Path | Description |
|---|---|---|---|
| Create a person | POST | /api/person/v2 | Create a new person record in SCM. |
| Update a person | PUT | /api/person/v2/{id} | Update details for an existing person. |
| Delete a person | DELETE | /api/person/v2/{id} | Delete a person record by ID. |
3. Invitations & enrollment endpoints
| Action | Method | Path | Description |
|---|---|---|---|
| Send an enrollment invitation | POST | /api/person/v2/{id}/invitation/send | Send an enrollment invitation to a person. |
| List enrollment endpoints for a person | GET | /api/person/v2/{id}/invitation/endpoint | List available endpoints for a person. |
| List enrollment endpoint accounts for a person | GET | /api/person/v2/{id}/invitation/endpoint/{endpointId}/account | List enrollment endpoint accounts for the person and endpoint. |
4. Key management
| Action | Method | Path | Description |
|---|---|---|---|
| Import a private key for a person | POST | /api/person/v2/{personId}/import-key | Import a private key for a person. |
Updated about 23 hours ago