Authenticate User

Authenticate a user

POST/data/authenticateuser.json

Use it in a workflow

Add a step and choose the Bazaarvoice connector.
Pick the Authenticate User action (under submission).
Fill in the fields below, then reference the result from later steps as {{authenticateUser.response.data}}.

Request

Query parameters

ApiVersionstringrequired

The API version, e.g. 5.4.

authtokenstringrequired

Value of the authentication token that was received in a user's authentication email. See the hostedauthentication_callbackurl parameter for more information.

PassKeystringrequired

API key is required to authenticate API user and check permission to access particular client's data.

Response

Returns 200 with an object. Read it in later steps with {{authenticateUser.response.data.<field>}}.

Dataobject

HasErrorsboolean

Formarray<object>

FormErrorsobject

TypicalHoursToPostnumber

The typical number of hours it takes for a user authentication request to be processed.

SubmissionIdstring

The submission ID.

Localestring

The locale of the user authentication request.

Errorsarray<object>

Authenticationobject

Userstring

The user identifier.

json

{
  "Data": {},
  "HasErrors": false,
  "Form": [
    {}
  ],
  "FormErrors": {},
  "TypicalHoursToPost": 0,
  "SubmissionId": "string",
  "Locale": "string",
  "Errors": [
    {}
  ],
  "Authentication": {
    "User": "string"
  }
}

Need more? See the Bazaarvoice guide for connection setup and behaviour shared by every action.

Was this page helpful?