Launch an Enrollment Automation

POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation }

Sets up a new enrollment automation for a specified user identity with a specified credential manager.

JavaScript

Request

await seam.userIdentities.enrollmentAutomations.launch({
  user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
  credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172",
  acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  create_credential_manager_user: true,
});

Response

{
  "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"
}

Python

Ruby

PHP

Seam CLI

Go

Authentication Methods

• API key

• Personal access token Must also include the seam-workspace header in the request.

Request Parameters

acs_credential_pool_id

Type: string Required: No

ID of the ACS credential pool from which to obtain credentials for the user identity.

---

create_credential_manager_user

Type: boolean Required: No

Indicates whether to create an associated credential manager user. If you set create_credential_manager_user to true, you cannot specify a credential_manager_acs_user_id.

---

credential_manager_acs_system_id

Type: string Required: Yes

ID of the desired ACS system that serves as the credential manager.

---

credential_manager_acs_user_id

Type: string Required: No

ID of the associated ACS user within the credential manager. If you specify a credential_manager_acs_user_id, you cannot set create_credential_manager_user to true.

---

user_identity_id

Type: string Required: Yes

ID of the desired user identity.

---

Return Type

unknown