API Overview Resources Schemas

Schemas

ChangePasswordRequest

1
2
3
4
5
6


{
  "language": "string",
  "new_password": "string",
  "old_password": "string",
  "username": "string"
}

Name	Type	Required	Description
language	string	false	Customer’s preferred language for communications
new_password	string	true	New password
old_password	string	true	Old password
username	string	true	Customer username

CreateUsernameRequest

1
2
3
4
5


{
  "customer_id": "string",
  "msisdn": "string",
  "username": "string"
}

Name	Type	Required	Description
customer_id	string	true	Internal identification of the customer
msisdn	string	true	Msisdn belonging to the customer
username	string	true	Username to be linked to the customer

Credential

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


{
  "created_at": "2019-08-24T14:15:22Z",
  "deleted_at": {
    "Time": "2019-08-24T14:15:22Z",
    "Valid": true
  },
  "enabled": true,
  "require2fa": true,
  "id": "string",
  "last_login_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "username": "string",
  "crm": "qvantel"
}

Name	Type	Required	Description
created_at	string(date-time)	true	Creation date
deleted_at	DeletedAt	false	Deletion date. It’s a nullTime which represents a time.Time that may be null.
enabled	boolean	true	If true it’s enabled
require2fa	boolean	false	If true the 2fa is required
id	string	false	none
last_login_at	string(date-time)	true	Date of last successful login
updated_at	string(date-time)	true	Date of last update
username	string	true	Username
crm	string	true	the crm where the credential belongs to

DeletedAt

1
2
3
4


{
  "Time": "2019-08-24T14:15:22Z",
  "Valid": true
}

Name	Type	Required	Description
Time	string(date-time)	false	Deletion date
Valid	boolean	false	true is valid

ErrorDto

1
2
3
4
5
6
7


{
  "componentMsg": "string",
  "id": "string",
  "msg": "string",
  "sentryCode": "string",
  "status": 0
}

Name	Type	Required	Description
componentMsg	string	true	Internal message
id	string	true	Unique id identifying the error
msg	string	true	Display message
sentryCode	string	false	Unique id identifying the error
status	integer(int64)	true	Equivalent http error code

InboundChangeStatusCredential

1
2
3
4


{
  "enabled": true,
  "require2fa": true
}

Name	Type	Required	Description
enabled	boolean	true	Enables or disables the credential
require2fa	boolean	false	If true the 2fa is required

InboundCredential

1
2
3
4


{
  "password": "string",
  "token": "string"
}

Name	Type	Required	Description
password	string	true	New password for the customer credential
token	string	true	Security token issued in order to change passwords

GenerateOTPRequest

1
2
3
4


{
  "language": "es",
  "hint": "user@masmovil.com"
}

Name	Type	Required	Description
language	string	false	Customer’s preferred language for communications
hint	string	false	Customer’s preferred channel to send otp

ValidateOTPRequest

1
2
3


{
  "code": "280597"
}

Name	Type	Required	Description
code	string	false	OTP to validate

GenerateOTPResponse

1
2
3


{
  "expires_in": 300
}

Name	Type	Required	Description
expires_in	integer(int64)	true	Time to live in seconds

GeneratePasscodeResponse

1
2
3
4


{
  "expires_in": 30,
  "passcode": "280597"
}

Name	Type	Required	Description
expires_in	integer(int64)	true	Time to live in seconds
passcode	string	false	OTP to validate

ResetPasswordRequest

1
2
3
4
5


{
  "language": "string",
  "username": "string",
  "hint": "user@masmovil.com"
}

Name	Type	Required	Description
language	string	false	Customer’s preferred language for communications
username	string	true	Customer username
hint	string	false	Customer’s preferred channel to send otp

TokenResponse

1
2
3


{
  "token": "ed7f4ab1-6234-46e6-a4de-fd3d4de3d414@masmovil@h7sn381lTBopU7pLIljv36pWzPTEy-FlswJznI_JqVoxbUXi40XJP8ekJ_1Owtrvzo4FOqIXCtABHhLPJ7rrHAa2UchVqWHuYQZyBCcutP_ryfegNNjC8OWYNc0Mf-mAg1O_GEA50pEXh9UkXINuCikK_XmgDonQhOmRwHC_qiU="
}

Name	Type	Required	Description
token	string	true	Security token issued in order to change passwords

TokenUsernameResponse

1
2
3


{
  "username": "myemail@gmail.com"
}

Name	Type	Required	Description
username	string	true	Customer username

MagicLinkResponse

1
2
3
4


{
  "token": "ed7f4ab1-6234-46e6-a4de-fd3d4de3d414@masmovil@h7sn381lTBopU7pLIljv36pWzPTEy-FlswJznI_JqVoxbUXi40XJP8ekJ_1Owtrvzo4FOqIXCtABHhLPJ7rrHAa2UchVqWHuYQZyBCcutP_ryfegNNjC8OWYNc0Mf-mAg1O_GEA50pEXh9UkXINuCikK_XmgDonQhOmRwHC_qiU=",
  "link": "https://{{authn-host}}/magiclink?token=ed7f4ab1-6234-46e6-a4de-fd3d4de3d414@masmovil@h7sn381lTBopU7pLIljv36pWzPTEy-FlswJznI_JqVoxbUXi40XJP8ekJ_1Owtrvzo4FOqIXCtABHhLPJ7rrHAa2UchVqWHuYQZyBCcutP_ryfegNNjC8OWYNc0Mf-mAg1O_GEA50pEXh9UkXINuCikK_XmgDonQhOmRwHC_qiU="
}

Name	Type	Required	Description
token	string	true	Security token issued to be able to login without using credentials
link	string	true	Link to Authn where the issued security token is sent to be able to login without using credentials.

Device

1
2
3
4
5
6
7


{
  "device_id": "e75ebfe3-b976-4b55-be1d-3f0fb68ff916",
  "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36",
  "user_agent_alias": "My Iphone 16",
  "created_at": 1718618235,
  "expires_at": 1726411355
}

Name	Type	Required	Description
device_id	string	false	Unique identifier for the device
user_agent	string	false	User agent of the device
user_agent_alias	string	false	User agent alias of the device
created_at	integer	false	Timestamp (in Unix time) when the device was connected
expires_at	integer	false	Timestamp (in Unix time) when the device’s connection expires

DevicesListResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "devices": [
    {
      "device_id": "e75ebfe3-b976-4b55-be1d-3f0fb68ff916",
      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36",
      "user_agent_alias": "My Iphone 16",
      "created_at": 1718618235,
      "expires_at": 1726411355
    }
  ]
}

Name	Type	Required	Description
devices	[Device]	false	none