Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Excerpt
hiddentrue

Set up User Creation API to allow a user to be created from the a third party contact screen.


This User Creation (REST) API is called with a payload of the user information from the a third party provider's contact screen. The web application will run validations and create the user after the validations are passed. An option in the payload is to specify whether a welcome email is to be sent to the user. Password is set via link in the email.

...

2. In Access Token URL, enter the URL (given to you). 


43. Add the Client ID and Client Secret provided to you.

64. Click Get New Access Token to get the token. 

75. The response is an object with two fields:

  • Token Type: this is the authorisation type that is needed for the api calls (should be 'bearer' usually)
  • Access Token: this is the actual token


6. Click Use Token.

2. Make the API call

(note to self- waiting for data)

...

2. Enter the URL (domain name) and then add /api/user

The API request returns the headers and payload in JSON.


3. In the Authorizations tab, select 'OAuth 2.0'

...

4. In the Body tab, select Raw, then JSON. The API request will return the payload in JSON.

5. Click Send.


NOTE - The response object should contain a response that allows you to see whether the call succeeded and whatever response information the call will return. All responses should contain "Success" and may contain "Message" (it should have the field but might have no content depending on the service). All other fields on the response object are endpoint specific.

...