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

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

Authorization

pat_with_workspaceconsole_sessionapi_key

Body

application/json

user_identity_id*string (uuid)

credential_manager_acs_system_id*string (uuid)

acs_credential_pool_idstring (uuid)

create_credential_manager_userboolean

credential_manager_acs_user_idstring (uuid)

Response

200400401

OK

Body

application/json

enrollment_automation*object

ok*boolean

Request

JavaScriptCurl

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

Response

{
  "enrollment_automation": {
    "acs_credential_provisioning_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": "2024-04-27T08:24:57.621Z",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "enrollment_automation_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "ok": false
}

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

enrollmentAutomation, uErr := client.UserIdentities.EnrollmentAutomations.Launch(context.Background(), &useridentities.EnrollmentAutomationsLaunchRequest{
    UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
    CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172",
    AcsCredentialPoolId: api.String("3fa85f64-5717-4562-b3fc-2c963f66afa6"),
    CreateCredentialManagerUser: api.Bool(true),
})

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
}