Launch an Enrollment Automation

• Request Parameters

• Response

• Examples

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

Signature

POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation }

Authentication Methods

• API key

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

To learn more, see Authentication.

Request Parameters

credential_manager_acs_system_id String (Required)

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

---

user_identity_id String (Required)

ID of the desired user identity.

---

acs_credential_pool_id String

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

---

create_credential_manager_user Boolean

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

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.

---

Response

unknown

JSON

{
  JSON representation of unknown
}

---

Examples

Launch an enrollment automation

Specify the desired user_identity_id and credential_manager_acs_system_id. You can also specify an acs_credential_pool_id. Either set create_credential_manager_user to true or specify the credential_manager_acs_user_id.

JavaScript

Code

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,
});

Output

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

Code

seam.user_identities.enrollment_automations.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,
)

Output

Unknown(
    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",
)

Ruby

Code

seam.user_identities.enrollment_automations.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,
)

Output

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

PHP

Code

<?php
$seam->user_identities->enrollment_automations->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
);

Output

<?php
[
    "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",
];

Seam CLI

Code

seam user-identities enrollment-automations 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

Output

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

Go

Code

package main

import api "github.com/seamapi/go"
import enrollmentautomations "github.com/seamapi/go/enrollmentautomations"

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

Output

api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"}

cURL

Code

curl --include --request POST "https://connect.getseam.com/user_identities/enrollment_automations/launch" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "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
}
EOF

Output

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