List Enrollment Automations

Get all enrollment automations for a specified user identity

Returns a list of all enrollment automations for a specified user identity.

/user_identities/enrollment_automations/list

POSThttps://connect.getseam.com/user_identities/enrollment_automations/list

Authorization

client_sessionpat_with_workspaceconsole_sessionapi_key

Body

application/json

user_identity_id*string (uuid)

Response

200400401

OK

Body

application/json

enrollment_automations*array of enrollment_automation (object)

ok*boolean

Request

JavaScriptCurl

const response = await fetch('https://connect.getseam.com/user_identities/enrollment_automations/list', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Client Session Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "user_identity_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

{
  "enrollment_automations": [
    {
      "credential_manager_acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
      "user_identity_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2024-04-27T06:32:49.889Z",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "enrollment_automation_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "ok": false
}

Request

Specify the user identity for which you want to retrieve all enrollment automations by including the corresponding acs_system_id in the request body.

Request Body Parameters

Parameter	Type	Description
user_identity_id	String Required	ID of the user identity for which you want to retrieve all enrollment automations

Sample Request

cURL (bash)

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/user_identities/enrollment_automations/list' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f"
}'

Go

enrollmentAutomations, uErr := client.UserIdentities.EnrollmentAutomations.List(context.Background(), &useridentities.EnrollmentAutomationsListRequest{
    UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
})

if uErr != nil {
    return uErr
}

fmt.Println(enrollmentAutomations)
return nil

Response

Returns an enrollment_automations array, in which each returned enrollment automation (enrollment_automation) contains the following properties:

Property	Description
user_identity_id	ID of the associated user identity
enrollment_automation_id	ID of the enrollment automation
acs_credential_provisioning_automation_id	ID of the ACS credential provisioning automation
credential_manager_acs_system_id	ID of the associated ACS system that serves as the credential manager
is_running	Boolean value to indicate whether the enrollment automation is running
workspace_id	ID of the workspace that contains the enrollment automation
created_at	Date and time at which the enrollment automation was created

This response also includes a Boolean ok status indicator.

Sample Response

JSON

{
  "enrollment_automations": [
    {
      "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
      "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895",
      "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895",
      "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172",
      "is_running": true,
      "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
      "created_at": "2024-01-09T05:45:33.068Z"
    }
  ],
  "ok": true
}