This RPC is useful to check the existence of a user within the Adways environment. On success, it gives an Adways user id ("UserManager" API entity's id) from a credential ("authorization" and "x-token-provider" fields in the header). On Fail, it gives only a message. The response body "success" field is a boolean set to "true" on success and to "false" on fail. Note that the response body "user_id" field is only available on success (not empty on fail, but missing).

Creates an entity in Identify. Required fields are in the API fields description above. Note that on success, the returned http status is "201, Created".

Request

EndPoint

https://services.adways.com/identify

Headers

Header Value
Accept
application/vnd.identifier.v1+json
application/json
application/*+json
Content-Type
application/vnd.identifier.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.identifier.v1+json
application/json
application/*+json
Allow Comma-separated list of all HTTP methods allowed

Body

{
"success": "boolean, true if user found",
"user_id": "integer, adways user id",
"message": ""
}						

Loads a collection of available entities. The loaded collection is paginated. An optional "search" parameter is available to filter the result on the entities' name and id (ex.: "//identify?search=SearchValue").

Request

EndPoint

https://services.adways.com/identify

Headers

Header Value
Accept
application/vnd.identifier.v1+json
application/json
application/*+json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 403: Forbidden

Headers

Header Value
Content-Type
application/vnd.identifier.v1+json
application/json
application/*+json
Allow Comma-separated list of all HTTP methods allowed

Body

{
    "_links": {
        "self": {
            "href": "/identify"
        },
        "first": {
            "href": "/identify?page={page}"
        },
        "prev": {
            "href": "/identify?page={page}"
        },
        "next": {
            "href": "/identify?page={page}"
        },
        "last": {
            "href": "/identify?page={page}"
        }
    },
    "_embedded": {
        "collection": [
            {
                "id": "",
                "created": "",
                "author": "",
                "updated": "",
                "updator": "",
                "level": "",
                "state": "",
                "_links": {
                    "self": {
                        "href": "/identify"
                    }
                }
            }
        ]
    }
}