Endpoint URL: {identityDomain} /config/{appId} /flows/{flow} /2faMessages
Description
Adds the default collection of 2FA messages to the specified flow.
Respects the API Client Allow List: No
URI Parameters
URI parameters that must be included in the request are listed in the following table:
Parameter | Type | Required | Description |
{appId} | string | Yes | Unique identifier of the Identity Cloud application associated with the 2FA messages. |
{flow} | string | Yes | Name of the flow where the 2FA messages are being added. Note that flow names are case-sensitive: if your flow is named standard then an error occurs if you list the flow as, say, Standard. |
API Client Permissions
The following table indicates the API clients that can (and the API clients that can't) be used to call this endpoint:
owner | access_issuer | direct_access | direct_read_access | login_client |
Yes | No | Yes | No | No |
Authentication
This endpoint requires Basic authentication. When configuring authentication, use your client ID as the username and your client secret as the password.
Sample Request (curl)
The following command adds the default set of 2FA messages to the standard flow:
curl -L -X POST \ 'https://v1.api.us.janrain.com/config/79y4mqf2rt3bxs378kw5479xdu/flows/standard/ 2faMessages' \ -H 'Authorization: Basic eTR4Zmc2ZjQ0bXNhYzN2ZXBqanZ4Z2d6dnQzZTNzazk6OTVjY3hrN2 N6YnZ1eng2ZHB0ZTVrOXA2ZGo1Ynpla3U='
Responses
204 No Content
No API response is returned if your call succeeds. However, you will get back the HTTP status code 204 No Content.
Error Response Codes
The following table includes information about some of the other response codes that you might encounter when calling this endpoint.
Response Code | Description |
409 | This flow already has 2faMessages. Occurs if you make an API call against a flow that already contains a set of 2FA messages. You cannot use this endpoint to overwrite an existing set of messages. |