RapidIdentity Product Guides - 2019 Rolling Release

API Call to Create Custom Key:Value

Once the new session is established the custom i18n key:value pairs can be created.

Follow these seven steps to create the custom i18n key:value pair.

  1. Using Postman, cURL, or another HTTP client, submit a POST call to the following path to create a new custom key/value pair.

    POST api/rest/admin/resourceBundles/persistent/custom_i18n/{key}

    Currently, there are three supported keys that can be passed into this API call.

    1.  federation.label_claim_my_account

    2.  federation.label_forgot_my_password

    3.  federation.label_forgot_my_username

  2. In the Headers field, enter two key:value pairs.

    1.  Enter Authorization as the key and Bearer {value} as the value.

    2.  Enter Content Type as the key and text/plain as the value. 

    Legacy_API_Call_Custom_Key_1.png

    To obtain the Bearer value, open Portal in the same cluster and then open the browser developer tools. Navigate to Network | All and refresh the page.

    Select bootstrapInfo. Scroll to the Request Headers section to locate Authorization: Bearer {value}.

  3. In the Body field, select Raw and text/plain. In the body, enter Claim My Account.

    Legacy_API_Call_Claim_Account.png
  4. Send the API call. A 204 status code returns to indicate that the API call was processed correctly.  

    Legacy_API_Call_Successful.png
  5. You can use the following cURL example to create a custom key/value pair:

    curl -X POST https://server.domain/api/rest/admin/resourceBundles/
                persistent/custom_i18n/federation.label_claim_my_account
    -H 'authorization: Bearer Fa4tmCTxzScJwVmY045joevX0YWoR3pn'
    -H 'cache-control: no-cache'
    -H 'content-type: text/plain'
    -d 'Claim My Account'       
  6. Navigate to RapidIdentity Appliance | Localization. The custom i18n bundle should be present at the top of the page. 

    Legacy_API_Call_Complete.png
  7. Repeat this second API call sequence for the remaining Federation self-service keys.