Funciones de la API de Usuario

Esta sección describe las operaciones relacionadas con los usuarios.

Crear un usuario

Crea una nueva cuenta de usuario.

Punto final: https://petstore3.swagger.io/api/v3/user

Operación: POST

Ejemplos

Clave API

POST "https://petstore3.swagger.io/api/v3/user" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "api_key: <TU_CLAVE_API>" \
-d '{
  "id": 0,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "userStatus": 0
}'

OAuth 2.0

POST "https://petstore3.swagger.io/api/v3/user" \
-H "accept: application/json" \
-H "Authorization: Bearer <TU_TOKEN_OAUTH>" \
-H "Content-Type: application/json" \
-d '{
  "id": 0,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "userStatus": 0
}'

Respuestas

Código	Descripción
default	operación exitosa

Ejemplo de respuesta

200: operación exitosa

{
  "id": 10,
  "username": "theUser",
  "firstName": "John",
  "lastName": "James",
  "email": "john@email.com",
  "password": "12345",
  "phone": "12345",
  "userStatus": 1
}

Parámetros

Cuerpo de la solicitud

Nombre	Tipo	Descripción
body	Objeto usuario	(Obligatorio) El objeto User para crear.

Crear una lista de usuarios con lista

Crea una lista de usuarios con la lista de entrada dada.

Punto final: https://petstore3.swagger.io/api/v3/user/createWithList

Operación: POST

Ejemplos

Ejemplos

Clave API

POST "https://petstore3.swagger.io/api/v3/user/createWithList" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "api_key: <TU_CLAVE_API>" \
-d \
  [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "password": "string",
      "phone": "string",
      "userStatus": 0
    }
  ]

OAuth 2.0

POST "https://petstore3.swagger.io/api/v3/user/createWithList" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <TU_TOKEN_OAUTH>" \
-d \
  [
    {
      "id": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "password": "string",
      "phone": "string",
      "userStatus": 0
    }
  ]

Respuestas

Código	Descripción
default	operación exitosa

Ejemplo de respuesta

200: Operación exitosa

{
  "id": 0,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "userStatus": 0
}

Parámetros

Cuerpo de la solicitud

Nombre	Tipo	Descripción
body	Arreglo de objetos Usuario	(Obligatorio) La lista de objetos User para crear.

Iniciar sesión

Inicia la sesión del usuario en el sistema.

Punto final: https://petstore3.swagger.io/api/v3/user/login

Operación: GET

Ejemplos

Clave API

GET "https://petstore3.swagger.io/api/v3/user/login?username=string&password=string" \
-H "accept: application/json" \
-H "api_key: <TU_CLAVE_API>"

OAuth 2.0

GET "https://petstore3.swagger.io/api/v3/user/login?username=string&password=string" \
-H "accept: application/json" \
-H "Authorization: Bearer <TU_TOKEN_OAUTH>"

Respuestas

Código	Descripción
200	operación exitosa
400	Nombre de usuario/contraseña inválidos suministrados
default	Error inesperado

Ejemplo de respuesta

200: operación exitosa

{
  "message": "sesión de usuario iniciada:abcdef12345"
}

Encabezados:

Nombre	Descripción	Tipo
X-Rate-Limit	Llamadas por hora permitidas por el usuario.	entero
X-Expires-After	Fecha en UTC cuando expira el token.	cadena

Parámetros

Parámetros de consulta

Nombre	Tipo	Descripción
username	string	El nombre de usuario para iniciar sesión.
password	string	La contraseña para iniciar sesión en texto plano.

Cerrar sesión

Cierra la sesión de usuario iniciada actualmente.

Punto final: https://petstore3.swagger.io/api/v3/user/logout

Operación: GET

Ejemplos

Clave API

GET "https://petstore3.swagger.io/api/v3/user/logout" \
-H "accept: application/json" \
-H "api_key: <TU_CLAVE_API>"

OAuth 2.0

GET "https://petstore3.swagger.io/api/v3/user/logout" \
-H "accept: application/json" \
-H "Authorization: Bearer <TU_TOKEN_OAUTH>"

Respuestas

Código	Descripción
200	operación exitosa
default	operación exitosa

Ejemplo de respuesta

200: operación exitosa

{
  "message": "Cierre de sesión exitoso"
}

Parámetros

Ninguno

Obtener usuario por nombre de usuario

Obtiene un usuario por su nombre de usuario.

Punto final: https://petstore3.swagger.io/api/v3/user/{username}

Operación: GET

Ejemplos

Clave API

GET "https://petstore3.swagger.io/api/v3/user/user1" \
-H "accept: application/json" \
-H "api_key: <TU_CLAVE_API>"

OAuth 2.0

GET "https://petstore3.swagger.io/api/v3/user/user1" \
-H "accept: application/json" \
-H "Authorization: Bearer <TU_TOKEN_OAUTH>"

Respuestas

Código	Descripción
200	operación exitosa
400	Nombre de usuario inválido suministrado
404	Usuario no encontrado
default	Error inesperado

200: operación exitosa

{
  "id": 0,
  "username": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "userStatus": 0
}

Parámetros

Parámetros de ruta

Nombre	Tipo	Descripción
username	string	El nombre de usuario del usuario a buscar. Use "user" para probar.

Actualizar un usuario

Actualiza un usuario.

Punto final: https://petstore3.swagger.io/api/v3/user/{username}

Operación: PUT

Ejemplos

Clave API

PUT "https://petstore3.swagger.io/api/v3/user/user1" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "api_key: <TU_CLAVE_API>" \
-d '{
  "id": 0,
  "username": "user1",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "userStatus": 0
}'

OAuth 2.0

PUT "https://petstore3.swagger.io/api/v3/user/user1" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <TU_TOKEN_OAUTH>" \
-d '{
  "id": 0,
  "username": "user1",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "userStatus": 0
}'

Respuestas

Código	Descripción
200	Operación exitosa
400	Usuario inválido suministrado
404	Usuario no encontrado
default	Error inesperado

(Una actualización exitosa devuelve un código 200 sin cuerpo de respuesta.)

Parámetros

Parámetros de ruta

Nombre	Tipo	Descripción
username	string	El nombre de usuario del usuario a actualizar

Cuerpo de la solicitud

Nombre	Tipo	Descripción
body	Objeto usuario	(Obligatorio) El objeto User con información actualizada.

Eliminar un usuario

Elimina un usuario.

Punto final: https://petstore3.swagger.io/api/v3/user/{username}

Operación: DELETE

Ejemplos

Clave API

DELETE "https://petstore3.swagger.io/api/v3/user/user1" \
-H "accept: application/json" \
-H "api_key: <TU_CLAVE_API>"

OAuth 2.0

DELETE "https://petstore3.swagger.io/api/v3/user/user1" \
-H "accept: application/json" \
-H "Authorization: Bearer <TU_TOKEN_OAUTH>"

Respuestas

Código	Descripción
200	Usuario eliminado
400	Nombre de usuario inválido suministrado
404	Usuario no encontrado

(Una eliminación exitosa devuelve un código 200 sin cuerpo de respuesta.)

Parámetros

Parámetros de ruta

Nombre	Tipo	Descripción
username	string	El nombre de usuario del usuario a eliminar