Launch an Enrollment Automation

Initialize a specified user identity with a specified credential manager

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

/user_identities/enrollment_automations/launch

post

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

Authorizations

pat_with_workspaceconsole_session_with_workspaceapi_key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

user_identity_idstring · uuidRequired

ID of the user identity for which you want to launch an enrollment automation.

credential_manager_acs_system_idstring · uuidRequired

ID of the desired access system that serves as the credential manager for the enrollment automation.

acs_credential_pool_idstring · uuidOptional

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

create_credential_manager_userbooleanOptional

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_user_idstring · uuidOptional

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

Responses

200

OK

application/json

okbooleanRequired

400

Bad Request

401

Unauthorized

post

/user_identities/enrollment_automations/launch

HTTPcURLJavaScriptPython

POST /user_identities/enrollment_automations/launch HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 307

{
  "user_identity_id": "123e4567-e89b-12d3-a456-426614174000",
  "credential_manager_acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
  "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000",
  "create_credential_manager_user": true,
  "credential_manager_acs_user_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "enrollment_automation": {
    "enrollment_automation_id": "123e4567-e89b-12d3-a456-426614174000",
    "credential_manager_acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
    "user_identity_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2026-02-22T09:48:31.239Z",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "ok": true
}

Request

Specify the desired user identity and credential manager by including the corresponding user_identity_id and credential_manager_acs_system_id in the request body. You can also either specify an existing credential_manager_acs_user_id for the user identity or indicate that you want to create a new credential manager user. Further, you can specify an acs_credential_pool_id from which to obtain credentials for the user identity.

Request Body Parameters

Parameter	Type	Description
user_identity_id	String Required	ID of the desired user identity
credential_manager_acs_system_id	String Required	ID of the desired ACS system that serves as the credential manager
acs_credential_pool_id	String Optional	ID of the ACS credential pool from which to obtain credentials for the user identity
create_credential_manager_user	Boolean Optional	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_user_id	String Optional	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.

Sample Request

cURL (bash)

curl -X 'POST' \
  'https://connect.getseam.com/user_identities/enrollment_automations/launch' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "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
}'

Go

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
}