Check AuthKey available

Check if the authKey is available.

post

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Body

application/jsontext/jsonapplication/*+json

This class presentation for handle check authKey is available.

authKeystring · min: 1Required

The authKey request. This is the authKey to check if it is available.

Responses

200

OK

application/json

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

databooleanOptional

post

/api/v1/users/check-auth-key-available

HTTPcURLJavaScriptPython

POST /api/v1/users/check-auth-key-available HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "authKey": "text"
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": true,
  "errors": []
}