This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Register a User with a given username before they log in to the platform for the first time through this Authentication Provider. Preregistered users can be assigned to groups and roles prior to first login.
objectstringThe new user's username. This must match one of the provider's supported username patterns.
stringThe RID of the user's primary Organization. This may be changed when the user logs in for the first time depending on any configured Organization assignment rules.
stringstringstringmap<AttributeName, AttributeValues>1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/admin/enrollments/ri.control-panel.main.customer.466f812b-f974-4478-9d4f-90402cd3def6/authenticationProviders/ri.control-panel.main.saml.3faf689c-eaa1-4137-851f-81d58afe4c86/preregisterUser?preview=true" \
-d '{"organization":"ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa","givenName":"John","familyName":"Smith","attributes":{"multipass:givenName":["John"],"multipass:familyName":["Smith"],"multipass:email:primary":["jsmith@example.com"],"multipass:realm":["eab0a251-ca1a-4a84-a482-200edfb8026f"],"multipass:organization-rid":["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"],"department":["Finance"],"jobTitle":["Accountant"]},"email":"jsmith@example.com","username":"jsmith"}'1
f05f8da4-b84c-4fca-9c77-8af0b13d11de| Error Name | ||
|---|---|---|
Preregister | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not preregisterUser the AuthenticationProvider. | |
| Parameters | enrollmentRid, authenticationProviderRid | |
Authentication | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given AuthenticationProvider could not be found. | |
| Parameters | enrollmentRid, authenticationProviderRid | |
See Errors for a general overview of errors in the platform.