POST api/Auth/1/1/UsernameExists
Verificar si existe el nombre de usuario
Información del Request
Parametros de la URI
No posee parametros
Parametros del Body
Objeto que contiene los parámetros de la petición
SFE.Auth.Core.Requests.UsernameExistsRequest| Nombre | Descripción | Tipo | Información Adicional |
|---|---|---|---|
| username |
Nombre de usuario a buscar |
string |
Matching regular expression pattern: ^[0-9a-zA-Z.]+$ Max length: 100 |
|
Dirección de correo electrónico a buscar |
string |
Matching regular expression pattern: [\w._%+-]+@[\w.-]+\.[a-zA-Z]{2,4} Max length: 100 |
|
| mobile |
Número de teléfono móvil a buscar |
string |
Matching regular expression pattern: ^[0-9]+$ Max length: 50 Min length: 5 |
| documentNumber |
Numero de Documento a buscar |
string |
Max length: 150 |
| internationalPrefix | string |
Matching regular expression pattern: ^[0-9]+$ Max length: 5 Min length: 2 |
|
| preconfirmationAltId |
Id de la preconfirmación de número telefónico y/o email |
string |
Matching regular expression pattern: [0-9a-fA-F\-]{32,36} |
| userTypeAltId |
Identificador del tipo de usuario |
string |
Matching regular expression pattern: [0-9a-fA-F\-]{32,36} |
| onlyConfirmation |
Identificador si los datos existen |
boolean |
N/A |
| recoveryId |
Identificador de Recuperacion de Cuenta . Solo en caso de que la petición sea exitosa. |
integer |
N/A |
| userRegistrationId |
Id de la plantilla de registro |
integer |
N/A |
| applicationId |
Identificador de la aplicación que consume el API. Valor constante acordado con el cliente |
string |
N/A |
| applicationVersion |
Identificador de la versión de la aplicación |
string |
Max length: 100 |
| applicationOS |
Identificador del sistema operativo de la aplicación (en mayúsculas) Ejemplo: ANDROID, IOS |
string |
Max length: 100 |
| language |
Código ISO 639-1 de dos letras del idioma usado para los mensajes |
string |
Max length: 5 |
| deviceId |
Identificador del dispositivo registrado |
integer |
N/A |
| deviceAltId |
Identificador alternativo del dispositivo registrado |
string |
Max length: 128 |
| ipAddress |
Dirección IP pública del dispositivo |
string |
Matching regular expression pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3} |
| latitude |
Latitud dela ubicación enviada por dispositivo |
string |
Max length: 50 |
| longitude |
Longitud dela ubicación enviada por dispositivo |
string |
Max length: 50 |
| additionalParameters |
Datos adicionales |
Dictionary of string [key] and string [value] |
N/A |
Ejemplos de request:
application/json, text/json
{
"username": "sample string 1",
"email": "sample string 2",
"mobile": "sample string 3",
"documentNumber": "sample string 4",
"internationalPrefix": "sample string 5",
"preconfirmationAltId": "sample string 6",
"userTypeAltId": "sample string 7",
"onlyConfirmation": true,
"recoveryId": 9,
"userRegistrationId": 10,
"applicationId": "sample string 11",
"applicationVersion": "sample string 12",
"applicationOS": "sample string 13",
"language": "sample string 14",
"deviceId": 15,
"deviceAltId": "sample string 16",
"ipAddress": "sample string 17",
"latitude": "sample string 18",
"longitude": "sample string 19",
"additionalParameters": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
}
application/xml, text/xml
<UsernameExistsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">
<additionalParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</additionalParameters>
<applicationId>sample string 11</applicationId>
<applicationOS>sample string 13</applicationOS>
<applicationVersion>sample string 12</applicationVersion>
<deviceAltId>sample string 16</deviceAltId>
<deviceId>15</deviceId>
<ipAddress>sample string 17</ipAddress>
<language>sample string 14</language>
<latitude>sample string 18</latitude>
<longitude>sample string 19</longitude>
<documentNumber>sample string 4</documentNumber>
<email>sample string 2</email>
<internationalPrefix>sample string 5</internationalPrefix>
<mobile>sample string 3</mobile>
<onlyConfirmation>true</onlyConfirmation>
<preconfirmationAltId>sample string 6</preconfirmationAltId>
<recoveryId>9</recoveryId>
<userRegistrationId>10</userRegistrationId>
<userTypeAltId>sample string 7</userTypeAltId>
<username>sample string 1</username>
</UsernameExistsRequest>
Información del Response
Descripción de los parametros
KinPOS.API.GenericResultOfSFE.Auth.Core.Requests.UsernameExistsResponse| Nombre | Descripción | Tipo | Información Adicional |
|---|---|---|---|
| encryptedData | string |
N/A |
|
| response | SFE.Auth.Core.Requests.UsernameExistsResponse |
N/A |
Ejemplos de response:
application/json, text/json
{
"encryptedData": "sample string 1"
}