Identify

Public API endpoints for the Identify Extension

Public API endpoints by provider:

1. AWS Cognito

2. Auth0

3. Anonymous

4. NoLogin

5. Twitter

6. Google

7. Facebook

Custom providers or implementations can also be added by arrangement.

AWS Cognito

Get user profile

GEThttps://m-id-service-loadtest.monterosa.cloud/v1/user

Authorization

BearerAuth

Query parameters

Response

200400401403

Get Profile

Body

application/json

resultinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://m-id-service-loadtest.monterosa.cloud/v1/user', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "result": 1,
  "message": "OK",
  "data": {
    "data": {
      "username": "burger1111111",
      "email": "[e-mail]",
      "custom:terms_optin1": "1",
      "custom:terms_optin2": "1",
      "nickname": "burger1111111",
      "userId": "3bd439c2-8ffe-416e-94ed-456f83a91848",
      "loginHistory": [
        1633435562,
        1633435763
      ]
    },
    "custom:terms_optin2": "1",
    "custom:terms_optin1": "1",
    "updatedAt": "1633430188",
    "nickname": "burger1111111",
    "email": "[e-mail]",
    "devices": [
      {
        "deviceId": "16713b2d-3848-42c7-aeb0-f9714beac892",
        "lastLogin": 1633435763,
        "signUp": 1633435560,
        "userId": "3bd439c2-8ffe-416e-94ed-456f83a91848",
        "timeStamp": 1633435760,
        "signature": "41C96E76084CDAAC46268995187AF3827258CCA3"
      },
      {
        "deviceId": "a055da77-dcfe-4969-ae49-32c501f14e8a"
      }
    ]
  }
}

Register a new user

POSThttps://m-id-service-loadtest.monterosa.cloud/v1/user

Body

application/json

Register a new User

projectIdProjectId (string)

strategyStrategy (string)

providerProvider (string)

dataobject

Response

201400401403409

user created

Body

application/json

resultinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://m-id-service-loadtest.monterosa.cloud/v1/user', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "result": 1,
  "message": "User is Correctly Created",
  "data": {
    "data": {},
    "result": 1,
    "message": "User is Correctly Created"
  }
}

Update user data

PUThttps://m-id-service-loadtest.monterosa.cloud/v1/user

Authorization

BearerAuth

Body

application/json

Updatee user data

projectIdProjectId (string)

strategyStrategy (string)

providerProvider (string)

dataobject

Response

200400401403409

user created

Body

application/json

resultinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://m-id-service-loadtest.monterosa.cloud/v1/user', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "result": 1,
  "message": "User is Correctly Created",
  "data": {
    "email": "[e-mail]",
    "username": "Baratrum1112323445",
    "externalId": "42da3617-268b-4459-b460-3efda3db5513",
    "projectId": "a69a31e9-f2e6-4d5f-b080-6138c6a721b7"
  }
}

Change password

PUThttps://m-id-service-loadtest.monterosa.cloud/v1/user/change-password

Authorization

BearerAuth

Body

application/json

Change Password

projectIdProjectId (string)

strategyStrategy (string)

providerProvider (string)

dataobject

Response

200400401403

user created

Body

application/json

resultinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://m-id-service-loadtest.monterosa.cloud/v1/user/change-password', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "result": 1,
  "message": "password has been updated",
  "data": {
    "deviceId": "789f64dc-750d-4260-afef-7937062048e3",
    "timeStamp": 1614788250,
    "signature": "C4B23C2801C19B76C3DE7432B86B818D1D63C7C6",
    "externalId": "6432a1c6a7dd85071d79a3ccb651a095ca1abb139189492fc0e53fb427c1a036",
    "userId": "99b5e0ae-60b8-4667-8741-f4e1486d2b3a",
    "accessToken": "jwtAccessToken",
    "profileToken": "jwtProfileToken",
    "refreshToken": "jwtRefreshToken",
    "signUp": 1614788100
  }
}

Forgot password

PUThttps://m-id-service-loadtest.monterosa.cloud/v1/user/forgot-password

Authorization

BearerAuth

Body

application/json

Change Password

projectIdProjectId (string)

strategyStrategy (string)

providerProvider (string)

dataobject

Response

200400401403

user created

Body

application/json

resultinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://m-id-service-loadtest.monterosa.cloud/v1/user/forgot-password', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "result": 1,
  "message": "please check your email",
  "data": {}
}

Confirm password

POSThttps://m-id-service-loadtest.monterosa.cloud/v1/user/confirm-forgot-password

Authorization

BearerAuth

Body

application/json

Confirmation of password

projectIdProjectId (string)

strategyStrategy (string)

providerProvider (string)

dataobject

Response

200400401403

user created

Body

application/json

resultinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://m-id-service-loadtest.monterosa.cloud/v1/user/confirm-forgot-password', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "result": 1,
  "message": "please check your email",
  "data": {}
}

Refresh token

POSThttps://m-id-service-loadtest.monterosa.cloud/v1/user/refresh

Authorization

BearerAuth

Body

application/json

refresh token

projectIdProjectId (string)

strategyStrategy (string)

providerProvider (string)

deviceIdDeviceId (string)

refreshTokenRefreshTokenProperty (string)

Response

200400401403

user created

Body

application/json

resultinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://m-id-service-loadtest.monterosa.cloud/v1/user/refresh', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "result": 1,
  "message": "please check your email",
  "data": {}
}

Logout user

POSThttps://m-id-service-loadtest.monterosa.cloud/v1/user/logout

Authorization

BearerAuth

Body

application/json

logout user

projectIdProjectId (string)

strategyStrategy (string)

providerProvider (string)

Response

200400401403

user created

Body

application/json

resultinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://m-id-service-loadtest.monterosa.cloud/v1/user/logout', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "result": 1,
  "message": "please check your email",
  "data": {}
}

Login

this method logins user

PUThttps://m-id-service-loadtest.monterosa.cloud/v1/user/login

Body

application/json

projectIdProjectId (string)

strategyStrategy (string)

providerProvider (string)

dataobject

Response

200400401403404

user Logged

Body

application/json

resultinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://m-id-service-loadtest.monterosa.cloud/v1/user/login', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "result": 1,
  "message": "OK",
  "data": {
    "deviceId": "789f64dc-750d-4260-afef-7937062048e3",
    "timeStamp": 1614788250,
    "signature": "C4B23C2801C19B76C3DE7432B86B818D1D63C7C6",
    "externalId": "6432a1c6a7dd85071d79a3ccb651a095ca1abb139189492fc0e53fb427c1a036",
    "userId": "99b5e0ae-60b8-4667-8741-f4e1486d2b3a",
    "accessToken": "jwtAccessToken",
    "profileToken": "jwtProfileToken",
    "refreshToken": "jwtRefreshToken",
    "signUp": 1614788100
  }
}

Check user by token

GEThttps://m-id-service-loadtest.monterosa.cloud/v1/user/check

Authorization

BearerAuth

Query parameters

Response

200400401403500

Check

Body

application/json

resultinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://m-id-service-loadtest.monterosa.cloud/v1/user/check', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "result": 1,
  "message": "OK",
  "data": {
    "data": {
      "username": "burger1111111",
      "email": "[e-mail]",
      "custom:terms_optin1": "1",
      "custom:terms_optin2": "1",
      "nickname": "burger1111111",
      "userId": "3bd439c2-8ffe-416e-94ed-456f83a91848",
      "loginHistory": [
        1633435562,
        1633435763
      ]
    },
    "custom:terms_optin2": "1",
    "custom:terms_optin1": "1",
    "updatedAt": "1633430188",
    "nickname": "burger1111111",
    "email": "[e-mail]",
    "devices": [
      {
        "deviceId": "16713b2d-3848-42c7-aeb0-f9714beac892",
        "lastLogin": 1633435763,
        "signUp": 1633435560,
        "userId": "3bd439c2-8ffe-416e-94ed-456f83a91848",
        "timeStamp": 1633435760,
        "signature": "41C96E76084CDAAC46268995187AF3827258CCA3"
      },
      {
        "deviceId": "a055da77-dcfe-4969-ae49-32c501f14e8a"
      }
    ]
  }
}

Auth0

Get user profile

GEThttps://m-id-service-loadtest.monterosa.cloud/v1/user

Authorization

BearerAuth

Query parameters

Response

200400401403

Get Profile

Body

application/json

resultinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://m-id-service-loadtest.monterosa.cloud/v1/user', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "result": 1,
  "message": "OK",
  "data": {
    "username": "testUserAuthZero",
    "appProfile": {
      "data": "customUserObjectGoesHere"
    },
    "loginHistory": [
      1633435562,
      1633435763
    ]
  }
}

Update user data

PUThttps://m-id-service-loadtest.monterosa.cloud/v1/user

Authorization

BearerAuth

Body

application/json

Update user data

projectIdProjectId (string)

strategyStrategy (string)

providerProvider (string)

dataobject

Response

200400401403409

user created

Body

application/json

resultinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://m-id-service-loadtest.monterosa.cloud/v1/user', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "result": 1,
  "message": "User is Correctly Created",
  "data": {
    "externalId": "42da3617-268b-4459-b460-3efda3db5513",
    "projectId": "a69a31e9-f2e6-4d5f-b080-6138c6a721b7",
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
    "appProfile": {
      "data": "customUserObjectGoesHere"
    }
  }
}

Check user by token

GEThttps://m-id-service-loadtest.monterosa.cloud/v1/user/check

Authorization

BearerAuth

Query parameters

Response

200400401403500

Check

Body

application/json

resultinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://m-id-service-loadtest.monterosa.cloud/v1/user/check', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "result": 1,
  "message": "OK",
  "data": {
    "username": "testUserAuthZero",
    "appProfile": {
      "data": "customUserObjectGoesHere"
    },
    "loginHistory": [
      1633435562,
      1633435763
    ]
  }
}

Anonymous

register a new user

By passing in the appropriate parameters it will register a new user to the anonymous strategy

POSThttps://m-id-service-loadtest.monterosa.cloud/v1/user

Body

application/json

projectIdstring (uuid)

strategyenum

simplified

providerstring

dataobject

Response

201400401403409

user created

Body

application/json

resultinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://m-id-service-loadtest.monterosa.cloud/v1/user', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "result": 1,
  "message": "User is Correctly Created",
  "data": {
    "deviceId": "789f64dc-750d-4260-afef-7937062048e3",
    "timeStamp": 1614788100,
    "signature": "3AE9859EFC488CB58EF3590A44395A33C2519991",
    "externalId": "6432a1c6a7dd85071d79a3ccb651a095ca1abb139189492fc0e53fb427c1a036",
    "userId": "99b5e0ae-60b8-4667-8741-f4e1486d2b3a",
    "signUp": 1614788100,
    "isNew": true
  }
}

update user data

this method updates user data fields

PUThttps://m-id-service-loadtest.monterosa.cloud/v1/user/login

Body

application/json

projectIdstring (uuid)

strategyenum

simplified

providerstring

dataobject

Response

200400401403404

user Logged

Body

application/json

resultinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://m-id-service-loadtest.monterosa.cloud/v1/user/login', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "result": 1,
  "message": "OK",
  "data": {
    "deviceId": "789f64dc-750d-4260-afef-7937062048e3",
    "timeStamp": 1614788250,
    "signature": "C4B23C2801C19B76C3DE7432B86B818D1D63C7C6",
    "externalId": "6432a1c6a7dd85071d79a3ccb651a095ca1abb139189492fc0e53fb427c1a036",
    "userId": "99b5e0ae-60b8-4667-8741-f4e1486d2b3a",
    "signUp": 1614788100
  }
}

NoLogin

Fetch a users profile

GEThttps://m-id-service-loadtest.monterosa.cloud/v1/user

Query parameters

Response

200403404

Profile updated

Body

application/json

strategystrategy (any)

authentication strategy

providerprovider (any)

authentication provider

projectIdprojectId (any)

M/IC project id

externalIdexternalId (any)

unique user identifier

dataobject

resultnumber

messageany

Request

JavaScriptCurl

const response = await fetch('https://m-id-service-loadtest.monterosa.cloud/v1/user', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "strategy": "simplified",
  "provider": "noLogin",
  "projectId": "5d5b0676-ce0f-4058-b2bf-49af49f61cb5",
  "externalId": "0fdb53e30444b0ace4976d1604766123a574555ee42e4e17974805b186e37be4",
  "data": {
    "username": "Harvey",
    "loginHistory": [
      0
    ],
    "appProfile": {
      "events": {
        "match_one": {
          "score": 123,
          "claims": [
            "pro",
            "lucky_dip"
          ]
        },
        "match_x": {
          "screen_name": "@seebar",
          "avatar": "https://www.google.com/url?sa=i&url=https%3A%2F%2Fwww.digitalspy.com%2Fmovies%2Fa34292276%2Favatar-2-navi-new-sign-language%2F&psig=AOvVaw2k_99ZjdehAGFTh7_3OynI&ust=1633432432837000&source=images&cd=vfe&ved=0CAsQjRxqFwoTCOiYqJLQsPMCFQAAAAAdAAAAABAJ",
          "level": 99
        }
      },
      "validation_key": "9c0c036b6678f663ab6a3b6e75d58abe90cfd6697a9dad381711ed98d2866c8decaa1f57ba6f66e64cac642f3be783cfb58affde4c6262f04a638e78ed7306ce"
    }
  },
  "result": 1
}

create a user

POSThttps://m-id-service-loadtest.monterosa.cloud/v1/user

Body

application/json

strategystrategy (any)

authentication strategy

providerprovider (any)

authentication provider

projectIdprojectId (any)

M/IC project id

dataobject

Response

200201400403409

success

Body

application/json

dataobject

resultinteger

messagestring

Request

JavaScriptCurl

const response = await fetch('https://m-id-service-loadtest.monterosa.cloud/v1/user', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "data": {
    "deviceId": "7f06fd89-4063-4c60-90e8-dcb48c3d6e47",
    "timeStamp": 1633433370,
    "signature": "ABEA9F45EAAD40D5AB59D174AADAB15D7A216083",
    "externalId": "0fdb53e30444b0ace4976d1604766123a574555ee42e4e17974805b186e37be4",
    "userId": "14b44577-651b-48c4-b937-abdb68ad7151",
    "signup": 1633433370,
    "isNew": true,
    "username": "Harvey"
  },
  "message": "ok"
}

Update the `appProfile` property of a users profile

PUThttps://m-id-service-loadtest.monterosa.cloud/v1/user

Body

application/json

strategystrategy (any)

authentication strategy

providerprovider (any)

authentication provider

projectIdprojectId (any)

M/IC project id

externalIdexternalId (any)

unique user identifier

dataobject

Response

200403

Profile updated

Body

application/json

strategystrategy (any)

authentication strategy

providerprovider (any)

authentication provider

projectIdprojectId (any)

M/IC project id

externalIdexternalId (any)

unique user identifier

dataobject

resultnumber

messageany

Request

JavaScriptCurl

const response = await fetch('https://m-id-service-loadtest.monterosa.cloud/v1/user', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "strategy": "simplified",
  "provider": "noLogin",
  "projectId": "5d5b0676-ce0f-4058-b2bf-49af49f61cb5",
  "externalId": "0fdb53e30444b0ace4976d1604766123a574555ee42e4e17974805b186e37be4",
  "data": {
    "username": "Harvey",
    "loginHistory": [
      0
    ],
    "appProfile": {
      "events": {
        "match_one": {
          "score": 123,
          "claims": [
            "pro",
            "lucky_dip"
          ]
        },
        "match_x": {
          "screen_name": "@seebar",
          "avatar": "https://www.google.com/url?sa=i&url=https%3A%2F%2Fwww.digitalspy.com%2Fmovies%2Fa34292276%2Favatar-2-navi-new-sign-language%2F&psig=AOvVaw2k_99ZjdehAGFTh7_3OynI&ust=1633432432837000&source=images&cd=vfe&ved=0CAsQjRxqFwoTCOiYqJLQsPMCFQAAAAAdAAAAABAJ",
          "level": 99
        }
      },
      "validation_key": "9c0c036b6678f663ab6a3b6e75d58abe90cfd6697a9dad381711ed98d2866c8decaa1f57ba6f66e64cac642f3be783cfb58affde4c6262f04a638e78ed7306ce"
    }
  },
  "result": 1
}

Twitter

Check user by token (non standard)

GEThttps://m-id-public-api-dev-int24.lvis.io/v1/user/check/nonstandard

Authorization

BearerAuth

Query parameters

Response

200400401403500

Check

Body

application/json

resultinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://m-id-public-api-dev-int24.lvis.io/v1/user/check/nonstandard', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "result": 1,
  "message": "OK",
  "data": {
    "updatedAt": "1633430188",
    "nickname": "burger1111111",
    "email": "[e-mail]",
    "devices": [
      {
        "deviceId": "16713b2d-3848-42c7-aeb0-f9714beac892",
        "lastLogin": 1633435763,
        "signUp": 1633435560,
        "userId": "3bd439c2-8ffe-416e-94ed-456f83a91848",
        "timeStamp": 1633435760,
        "signature": "41C96E76084CDAAC46268995187AF3827258CCA3"
      },
      {
        "deviceId": "a055da77-dcfe-4969-ae49-32c501f14e8a"
      }
    ]
  }
}

Google

Check user by token (non standard)

GEThttps://m-id-public-api-dev-int24.lvis.io/v1/user/check/nonstandard

Authorization

BearerAuth

Query parameters

Response

200400401403500

Check

Body

application/json

resultinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://m-id-public-api-dev-int24.lvis.io/v1/user/check/nonstandard', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "result": 1,
  "message": "OK",
  "data": {
    "updatedAt": "1633430188",
    "nickname": "burger1111111",
    "email": "[e-mail]",
    "devices": [
      {
        "deviceId": "16713b2d-3848-42c7-aeb0-f9714beac892",
        "lastLogin": 1633435763,
        "signUp": 1633435560,
        "userId": "3bd439c2-8ffe-416e-94ed-456f83a91848",
        "timeStamp": 1633435760,
        "signature": "41C96E76084CDAAC46268995187AF3827258CCA3"
      },
      {
        "deviceId": "a055da77-dcfe-4969-ae49-32c501f14e8a"
      }
    ]
  }
}

Facebook

Check user by token (non standard)

GEThttps://m-id-public-api-dev-int24.lvis.io/v1/user/check/nonstandard

Authorization

BearerAuth

Query parameters

Response

200400401403500

Check

Body

application/json

resultinteger

messagestring

dataobject

Request

JavaScriptCurl

const response = await fetch('https://m-id-public-api-dev-int24.lvis.io/v1/user/check/nonstandard', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "result": 1,
  "message": "OK",
  "data": {
    "updatedAt": "1633430188",
    "nickname": "burger1111111",
    "email": "[e-mail]",
    "devices": [
      {
        "deviceId": "16713b2d-3848-42c7-aeb0-f9714beac892",
        "lastLogin": 1633435763,
        "signUp": 1633435560,
        "userId": "3bd439c2-8ffe-416e-94ed-456f83a91848",
        "timeStamp": 1633435760,
        "signature": "41C96E76084CDAAC46268995187AF3827258CCA3"
      },
      {
        "deviceId": "a055da77-dcfe-4969-ae49-32c501f14e8a"
      }
    ]
  }
}