description |
---|
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.
{% swagger src="https://connect.getseam.com/openapi.json" path="/user_identities/enrollment_automations/launch" method="post" %} https://connect.getseam.com/openapi.json {% endswagger %}
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.
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 . |
{% tabs %} {% tab title="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
}'
{% endtab %}
{% tab title="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
{% endtab %} {% endtabs %}
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.
{% tabs %} {% tab title="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
}
{% endtab %} {% endtabs %}