Get an Enrollment Automation

Get a specified enrollment automation

Returns a specified enrollment automation.

/user_identities/enrollment_automations/get

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

Authorization

client_sessionpat_with_workspaceconsole_sessionapi_key

Body

application/json

enrollment_automation_id*string (uuid)

Response

200400401

OK

Body

application/json

enrollment_automation*enrollment_automation (object)

ok*boolean

Request

JavaScriptCurlPython

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

Response

200

{
  "enrollment_automation": {
    "credential_manager_acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
    "user_identity_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2024-09-10T03:37:40.338Z",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "enrollment_automation_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "ok": false
}

Request

Specify the desired enrollment automation by including the corresponding enrollment_automation_id in the request body.

Request Body Parameters

Parameter	Type	Description
enrollment_automation_id	String Required	ID of the desired enrollment automation

Sample Request

cURL (bash)

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/user_identities/enrollment_automations/get' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895"
}'

Go

enrollmentAutomation, uErr := client.UserIdentities.EnrollmentAutomations.Get(
    context.Background(),
    useridentities.NewEnrollmentAutomationsGetRequestFromEnrollmentAutomationsGetRequestUserIdentityId(
        &useridentities.EnrollmentAutomationsGetRequestUserIdentityId{
            UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
        },
    ),
)

if uErr != nil {
    return uErr
}

fmt.Println(enrollmentAutomation)
return nil

Response

Returns an enrollment_automation containing 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_automation": {
    "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
}