---
title: Endpoints de usuarios (2022/06)
slug: develop/es/endpoints-de-usuarios-202206
docTags:
createdAt: 2025-03-11T07:03:30.743Z
---
Estos endpoints permiten la gestión de Users en una red. Un User es una instancia de una persona que está asociada con una única red (solo puede haber una persona, pero puede haber de 0 a un número infinito de usuarios en una red).
URL base para estos endpoints: ***https\://api.bsn.cloud/2022/06/REST/Users***
*\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_*
## GET /
Devuelve una lista de Users en una red
**Scope Token requerido**
bsn.api.main.users.retrieve
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Parámetros de Query String**
- `marcador` string opcional: Un valor que especifica qué página recuperar. Este valor es útil si la entrada `isTruncated` del cuerpo de respuesta de la llamada GET anterior indica que el número de Users excede el `pageSize`. Este parámetro solo es requerido si usted necesita más elementos en la lista paginada que el `pageSize` (100).
- `pageSize` int opcional: El número máximo de Users que pueden estar contenidos en el cuerpo de respuesta. De manera predeterminada, este valor es el tamaño máximo de página permitido (100).
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- `marcador` value se establece en el valor de la propiedad `[PagedList].[NextMarker]` de la respuesta anterior de la API de BSN.cloud.
- `pageSize` se establece en `1`
```text
GET /2022/06/REST/Users/?marker=RY0JlZW4tWW3hcnMsMTcyMU4&pageSize=1 HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Cuerpo de respuesta exitosa**
200: Devuelve una [lista paginada](docId:1GSmBtULb07Tf6mcfQCxP) de [Entidades User](docId\:LnIBIK7fZ9mxKIkMsurE1) en una red. Esto devolverá no más de 100 entidades junto con la información necesaria para devolver cualquier otra página restante.
**Ejemplo**
```json
{
"items": [ {
"id": 12345,
"person": {
"id": 1234,
"login": "JohnDoe@look.biz",
"password": null,
"firstName": "John",
"lastName": "Doe",
"creationDate": "2020-07-09T19:05:20.247Z",
"lastModifiedDate": "2023-11-29T17:40:54.403Z",
"activationDate": "2020-07-09T19:05:38.723Z"
},
"description": "Network Administrator",
"creationDate": "2020-07-09T19:09:04.98Z",
"lastModifiedDate": "2020-08-17T20:49:48.377Z",
"lastLoginDate": "2024-01-03T17:55:26.17Z",
"isLockedOut": false,
"lastLockoutDate": null,
"roleName": "Administrators",
"permissions": [
{
"entityId": 123456,
"operationUID": "67b9b0ab-fb5f-36c4-d598-a71aa8998e4e",
"principal": {
"login": "JohnDoe@look.biz",
"type": "User",
"id": 12345
},
"isFixed": true,
"isInherited": false,
"isAllowed": true,
"creationDate": "2020-08-17T20:49:48.353Z"
}
]
}],
"totalItemCount": 2,
"matchingItemCount": 2,
"pageSize": 1,
"nextMarker": "F32RY0JlZW4tWW3hcnMuMTcy00",
"prevMarker": "F32RY0JlZW4tWW3hcnMuMT78th",
"isTruncated": false,
"sortExpression": "[User].[Person].[Login] ASC",
"filterExpression": ""
}
```
**Respuesta de error**
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no fue especificado
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que usted solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
## POST /
Crea un usuario en una red
**Token de ámbito requerido**
bsn.api.main.users.create
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Cuerpo de la solicitud**
- La [Entidad de usuario](docId\:LnIBIK7fZ9mxKIkMsurE1)
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
```text
POST /2022/06/REST/Users/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 468
```
Este es el cuerpo de solicitud de ejemplo:
```json
{
"id": 0,
"person": {
"id": 0,
"login": "JohnDoe@host.com",
"password": null,
"firstName": "John",
"lastName": "Doe",
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"activationDate": null
},
"description": "Supervisor",
"creationDate": "0001-01-01T00:00:00",
"lastLoginDate": null,
"isLockedOut": false,
"lastLockoutDate": null,
"roleName": "Viewers",
"permissions": []
}
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Cuerpo de respuesta exitosa**
201: Devuelve la [Entidad de usuario](docId\:LnIBIK7fZ9mxKIkMsurE1) creada y referenciada por el Uri (proporcionado por el campo de encabezado Location) en la respuesta.
**Ejemplo**
```json
{
"id": 12345,
"person": {
"id": 12345,
"login": "JohnDoe@host.com",
"password": "7t#Sqg7*",
"firstName": "John",
"lastName": "Doe",
"creationDate": "2024-01-03T19:05:26.5480648Z",
"lastModifiedDate": "2024-01-03T19:05:26.5480648Z",
"activationDate": "2024-01-03T19:05:26.5480648Z"
},
"description": "Supervisor",
"creationDate": "2024-01-03T19:05:26.6198305Z",
"lastModifiedDate": "2024-01-03T19:05:26.9953066Z",
"lastLoginDate": null,
"isLockedOut": false,
"lastLockoutDate": null,
"roleName": "Viewers",
"permissions": [
{
"entityId": 30912,
"operationUID": "67b9b0ab-fb5f-36c4-d598-a71aa8998e4e",
"principal": {
"login": "JohnDoe@host.com",
"type": "User",
"id": 12345
},
"isFixed": true,
"isInherited": false,
"isAllowed": true,
"creationDate": "2024-01-03T19:05:26.9953066Z"
}
]
}
```
**Respuesta de error**
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que usted solicitó (según se especifica en el encabezado "Accept")
415: El servidor no puede aceptar la representación de datos que usted envió (según se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
## GET /\{login}/
Devuelve información para un usuario especificado en una red
**Token de ámbito requerido**
bsn.api.main.users.retrieve
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segmento**
- `inicio de sesión` string: La información de inicio de sesión del User
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- `inicio de sesión` se establece en `JaneDoe@brightsign.biz`
- El valor opcional del encabezado `If-Modified-Since` es igual al valor del encabezado `Última modificación` recuperado de la respuesta anterior de `GET /login` o `GET /id`
```text
GET /2022/06/REST/Users/JaneDoe%40brightsign.biz/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Respuesta correcta con cuerpo**
200: Devuelve la [Entidad de usuario](docId\:LnIBIK7fZ9mxKIkMsurE1)
**Ejemplo**
Este es un ejemplo de una respuesta correcta de nivel 200:
```json
{
"id": 123456,
"person": {
"id": 12345,
"login": "JaneDoe@brightsign.biz",
"password": null,
"firstName": "Jane",
"lastName": "Doe",
"creationDate": "2020-07-09T19:05:20.247Z",
"lastModifiedDate": "2020-08-17T20:49:48.377Z",
"activationDate": "2020-07-09T19:05:38.723Z"
},
"description": "Network Administrator",
"creationDate": "2020-07-09T19:09:04.98Z",
"lastModifiedDate": "2023-12-20T21:32:35.093Z",
"lastLoginDate": "2024-01-03T19:05:23.98Z",
"isLockedOut": false,
"lastLockoutDate": null,
"roleName": "Administrators",
"permissions": [
{
"entityId": 123456,
"operationUID": "67b9b0ab-fb5f-36c4-d598-a71aa8998e4e",
"principal": {
"login": "JaneDoe@brightsign.biz",
"type": "User",
"id": 12345
},
"isFixed": true,
"isInherited": false,
"isAllowed": true,
"creationDate": "2020-08-17T20:49:48.353Z"
}
]
}
```
**Respuesta correcta**
304: El recurso no se modificó desde el momento especificado en el encabezado “If-Modified-Since”
**Respuesta de error**
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
## PUT /\{login}/
Actualiza la información de un User especificado en una red
**Token de alcance requerido**
bsn.api.main.users.update
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segmento**
- `inicio de sesión` string: La información de inicio de sesión del User
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Cuerpo de la solicitud**
- La [Entidad de usuario](docId\:LnIBIK7fZ9mxKIkMsurE1)
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- `inicio de sesión` se establece en `JaneDoe@brightsign.biz`
- El valor opcional del encabezado `If-Unmodified-Since` es igual al valor del encabezado `Última modificación` recuperado de la respuesta de `GET /id` o `GET /login` .
```text
PUT /2022/06/REST/Users/JaneDoe%40brightsign.biz/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
If-Unmodified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Content-Type: application/json
Content-Length: 1440
```
Este es el cuerpo de la solicitud de ejemplo:
```json
{
"id": 123456,
"person": {
"id": 12345,
"login": "JaneDoe@brightsign.biz",
"password": null,
"firstName": "Jane",
"lastName": "Doe",
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"activationDate": "0001-01-01T00:00:00"
},
"description": "Network Administrator",
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"lastLoginDate": "0001-01-01T00:00:00",
"isLockedOut": false,
"lastLockoutDate": null,
"roleName": "Administrators",
"permissions": [
{
"entityId": 123456,
"operationUID": "67b9b0ab-fb5f-36c4-d598-a71aa8998e4e",
"principal": {
"login": "JaneDoe@brightsign.biz",
"type": "User",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "0001-01-01T00:00:00"
}
]
}
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Respuesta correcta**
204: La información del usuario se ha actualizado
**Respuesta de error**
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
412: Error de condición previa (el recurso cambió desde el momento especificado en el valor del encabezado “If-Unmodified-Since”)
415: El servidor no puede aceptar la representación de datos que usted envió (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
## DELETE /\{login}/
Elimina un usuario especificado en una red
**Token de alcance requerido**
bsn.api.main.users.delete
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segmento**
- `inicio de sesión` string: La información de inicio de sesión del usuario
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- `inicio de sesión` se establece en `JohnDoe@host.com`
- El valor opcional del encabezado `If-Unmodified-Since` es igual al valor del encabezado `Última modificación` recuperado de la respuesta de `GET /id` o `GET /login` .
```text
DELETE /2022/06/REST/Users/JohnDoe%40host.com/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Unmodified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Respuesta correcta**
204: La información del User especificado se eliminó correctamente
**Respuesta de error**
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida, o se rechaza de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
412: Falló la condición previa (el recurso cambió desde la hora especificada en el valor del encabezado “If-Unmodified-Since”)
5XX: Cualquier código 500 es un error interno del servidor
## GET /\{id}/
Devuelve información para un User especificado en una red.
**Token de alcance requerido**
bsn.api.main.users.retrieve
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segmento**
- `id` int: Un identificador único para un User
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- `id` se establece en `12345`
- El valor opcional del encabezado `If-Modified-Since` es igual al valor del encabezado `Última modificación` recuperado de la respuesta anterior de `GET /login` o `GET /id`
```text
GET /2022/06/REST/Users/12345/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Modified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Respuesta correcta con cuerpo**
200: Devuelve la [Entidad User](docId\:LnIBIK7fZ9mxKIkMsurE1)
**Ejemplo**
Este es un ejemplo de una respuesta de nivel 200:
```json
{
"id": 12345,
"person": {
"id": 12345,
"login": "JaneDoe@brightsign.biz",
"password": null,
"firstName": "Jane",
"lastName": "Doe",
"creationDate": "2020-07-09T19:05:20.247Z",
"lastModifiedDate": "2023-11-29T17:40:54.403Z",
"activationDate": "2020-07-09T19:05:38.723Z"
},
"description": "Network Administrator",
"creationDate": "2020-07-09T19:09:04.98Z",
"lastModifiedDate": "2020-08-17T20:49:48.377Z",
"lastLoginDate": "2024-01-03T19:05:23.98Z",
"isLockedOut": false,
"lastLockoutDate": null,
"roleName": "Administrators",
"permissions": [
{
"entityId": 123456,
"operationUID": "67b9b0ab-fb5f-36c4-d598-a71aa8998e4e",
"principal": {
"login": "JaneDoe@brightsign.biz",
"type": "User",
"id": 12345
},
"isFixed": true,
"isInherited": false,
"isAllowed": true,
"creationDate": "2020-08-17T20:49:48.353Z"
}
]
}
```
**Respuesta correcta**
304: El recurso no fue modificado desde el momento especificado en el encabezado “If-Modified-Since”
**Respuesta de error**
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no fue especificado
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
## PUT /\{id}/
Actualice la información del User proporcionado
**Token de Scope requerido**
bsn.api.main.users.update
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segmento**
- `id` int: Un identificador único para un User
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Cuerpo de la solicitud**
- El [Entidad User](docId\:LnIBIK7fZ9mxKIkMsurE1)
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- `id` se establece en `12345`
- El valor opcional del encabezado `If-Unmodified-Since` es igual al valor del encabezado `Última modificación` recuperado de la respuesta de `GET /id` o `GET /login`.
```text
PUT /2022/06/REST/Users/12345/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
If-Unmodified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Content-Type: application/json
Content-Length: 1440
```
Este es el cuerpo de la solicitud de ejemplo:
```json
{
"id": 12345,
"person": {
"id": 12345,
"login": "JaneDoe@brightsign.biz",
"password": null,
"firstName": "Jane",
"lastName": "Doe",
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"activationDate": "0001-01-01T00:00:00"
},
"description": "Network Administrator",
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00",
"lastLoginDate": "0001-01-01T00:00:00",
"isLockedOut": false,
"lastLockoutDate": null,
"roleName": "Administrators",
"permissions": [
{
"entityId": 123456,
"operationUID": "67b9b0ab-fb5f-36c4-d598-a71aa8998e4e",
"principal": {
"login": "JaneDoe@brightsign.biz",
"type": "User",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "0001-01-01T00:00:00"
}
]
}
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Respuesta satisfactoria**
204: La información del User ha sido actualizada
**Respuesta de error**
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud está mal formado y, por lo tanto, no es válido, o se rechaza de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
412: Falló la condición previa (el recurso cambió desde el momento especificado en el valor del encabezado “If-Unmodified-Since”)
415: El servidor no puede aceptar la representación de datos que usted envió (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
## DELETE /\{id}/
Elimina el User especificado en una red
**Token de Scope requerido**
bsn.api.main.users.delete
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segmento**
- `id` int: Un identificador único para un User
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de ejemplo de la solicitud se establecen de la siguiente manera:
- `id` se establece en `12345`
- El valor opcional del encabezado `If-Unmodified-Since` es igual al valor del encabezado `Última modificación` recuperado de la respuesta de `GET /id` o `GET /login`.
```text
DELETE /2022/06/REST/Users/12345/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
If-Unmodified-Since: Wed, 20 Dec 2023 21:32:34 GMT
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Respuesta satisfactoria**
204: La información del User especificado se eliminó correctamente
**Respuesta de error**
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud está mal formado y, por lo tanto, no es válido, o se rechaza de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
412: Falló la condición previa (el recurso cambió desde el momento especificado en el valor del encabezado “If-Unmodified-Since”)
5XX: Cualquier código 500 es un error interno del servidor
## GET /Operations/
Devuelve los permisos operativos otorgados a roles para operaciones de negocio específicas
**Token de alcance requerido**
bsn.api.main.operations.retrieve
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
```text
GET /2022/06/REST/Users/Operations/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Cuerpo de la respuesta exitosa**
200: Devuelve la [Entidad de operaciones de negocio](docId\:BB_TAuFfpLMvkrODV93I7)
:::ExpandableHeading
Ejemplo
```json
{
"uid": "b41ac545-d505-7014-edde-51bc4c0d21a0",
"singularName": "Full Control",
"pluralName": "User (Full Control)",
"fullName": "User (Full Control)",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": null,
"descendants": [
{
"uid": "1a0c5653-9f2f-4274-f922-f68b17d2d3e7",
"singularName": "View User",
"pluralName": "View Users",
"fullName": "User (Full Control) - View Users",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": {
"uid": "b41ac545-d505-7014-edde-51bc4c0d21a0",
"singularName": "Full Control",
"pluralName": "User (Full Control)",
"fullName": "User (Full Control)",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": null,
"descendants": null,
"permissions": null
},
"descendants": [],
"permissions": [
{
"entityId": null,
"operationUID": "1a0c5653-9f2f-4274-f922-f68b17d2d3e7",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2023-04-21T19:10:01.147Z"
},
{
"entityId": null,
"operationUID": "1a0c5653-9f2f-4274-f922-f68b17d2d3e7",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.16Z"
},
{
"entityId": null,
"operationUID": "1a0c5653-9f2f-4274-f922-f68b17d2d3e7",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.177Z"
},
{
"entityId": null,
"operationUID": "1a0c5653-9f2f-4274-f922-f68b17d2d3e7",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.197Z"
},
{
"entityId": null,
"operationUID": "1a0c5653-9f2f-4274-f922-f68b17d2d3e7",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.357Z"
},
{
"entityId": null,
"operationUID": "1a0c5653-9f2f-4274-f922-f68b17d2d3e7",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.41Z"
}
]
},
{
"uid": "1af1f3e0-db38-2bc4-29fb-f0f937139d89",
"singularName": "Create User",
"pluralName": "Create User",
"fullName": "User (Full Control) - Create User",
"targetEntity": "User",
"appliance": "Collection",
"parent": {
"uid": "b41ac545-d505-7014-edde-51bc4c0d21a0",
"singularName": "Full Control",
"pluralName": "User (Full Control)",
"fullName": "User (Full Control)",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": null,
"descendants": null,
"permissions": null
},
"descendants": [],
"permissions": [
{
"entityId": null,
"operationUID": "1af1f3e0-db38-2bc4-29fb-f0f937139d89",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2023-04-21T19:10:01.147Z"
},
{
"entityId": null,
"operationUID": "1af1f3e0-db38-2bc4-29fb-f0f937139d89",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.16Z"
},
{
"entityId": null,
"operationUID": "1af1f3e0-db38-2bc4-29fb-f0f937139d89",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.177Z"
},
{
"entityId": null,
"operationUID": "1af1f3e0-db38-2bc4-29fb-f0f937139d89",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.197Z"
},
{
"entityId": null,
"operationUID": "1af1f3e0-db38-2bc4-29fb-f0f937139d89",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.357Z"
},
{
"entityId": null,
"operationUID": "1af1f3e0-db38-2bc4-29fb-f0f937139d89",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.41Z"
}
]
},
{
"uid": "d1d32f0f-39fd-435a-bd49-35d76b9abdf2",
"singularName": "Manage Notifications",
"pluralName": "Manage Notifications",
"fullName": "User (Full Control) - Manage Notifications",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": {
"uid": "b41ac545-d505-7014-edde-51bc4c0d21a0",
"singularName": "Full Control",
"pluralName": "User (Full Control)",
"fullName": "User (Full Control)",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": null,
"descendants": null,
"permissions": null
},
"descendants": [],
"permissions": [
{
"entityId": null,
"operationUID": "d1d32f0f-39fd-435a-bd49-35d76b9abdf2",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-04-21T19:10:01.16Z"
},
{
"entityId": null,
"operationUID": "d1d32f0f-39fd-435a-bd49-35d76b9abdf2",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-04-21T19:10:01.36Z"
},
{
"entityId": null,
"operationUID": "d1d32f0f-39fd-435a-bd49-35d76b9abdf2",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-04-21T19:10:01.41Z"
},
{
"entityId": null,
"operationUID": "d1d32f0f-39fd-435a-bd49-35d76b9abdf2",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2023-04-21T19:10:01.147Z"
},
{
"entityId": null,
"operationUID": "d1d32f0f-39fd-435a-bd49-35d76b9abdf2",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.177Z"
},
{
"entityId": null,
"operationUID": "d1d32f0f-39fd-435a-bd49-35d76b9abdf2",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.197Z"
}
]
},
{
"uid": "cd9c31e0-d23c-1844-f9f8-dd49ce80e72a",
"singularName": "Change Role",
"pluralName": "Change Role",
"fullName": "User (Full Control) - Change Role",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": {
"uid": "b41ac545-d505-7014-edde-51bc4c0d21a0",
"singularName": "Full Control",
"pluralName": "User (Full Control)",
"fullName": "User (Full Control)",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": null,
"descendants": null,
"permissions": null
},
"descendants": [],
"permissions": [
{
"entityId": null,
"operationUID": "cd9c31e0-d23c-1844-f9f8-dd49ce80e72a",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2023-04-21T19:10:01.147Z"
},
{
"entityId": null,
"operationUID": "cd9c31e0-d23c-1844-f9f8-dd49ce80e72a",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.16Z"
},
{
"entityId": null,
"operationUID": "cd9c31e0-d23c-1844-f9f8-dd49ce80e72a",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.177Z"
},
{
"entityId": null,
"operationUID": "cd9c31e0-d23c-1844-f9f8-dd49ce80e72a",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.197Z"
},
{
"entityId": null,
"operationUID": "cd9c31e0-d23c-1844-f9f8-dd49ce80e72a",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.357Z"
},
{
"entityId": null,
"operationUID": "cd9c31e0-d23c-1844-f9f8-dd49ce80e72a",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.41Z"
}
]
},
{
"uid": "526a9b95-cce5-422a-99f8-9f02d63af74f",
"singularName": "Update User",
"pluralName": "Update User",
"fullName": "User (Full Control) - Update User",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": {
"uid": "b41ac545-d505-7014-edde-51bc4c0d21a0",
"singularName": "Full Control",
"pluralName": "User (Full Control)",
"fullName": "User (Full Control)",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": null,
"descendants": null,
"permissions": null
},
"descendants": [],
"permissions": [
{
"entityId": null,
"operationUID": "526a9b95-cce5-422a-99f8-9f02d63af74f",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2023-04-21T19:10:01.147Z"
},
{
"entityId": null,
"operationUID": "526a9b95-cce5-422a-99f8-9f02d63af74f",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.16Z"
},
{
"entityId": null,
"operationUID": "526a9b95-cce5-422a-99f8-9f02d63af74f",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.177Z"
},
{
"entityId": null,
"operationUID": "526a9b95-cce5-422a-99f8-9f02d63af74f",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.197Z"
},
{
"entityId": null,
"operationUID": "526a9b95-cce5-422a-99f8-9f02d63af74f",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.357Z"
},
{
"entityId": null,
"operationUID": "526a9b95-cce5-422a-99f8-9f02d63af74f",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.41Z"
}
]
},
{
"uid": "52f1b86c-46df-8fa4-5d75-f0c8702975e6",
"singularName": "Edit Permissions",
"pluralName": "Edit Permissions",
"fullName": "User (Full Control) - Edit Permissions",
"targetEntity": "User",
"appliance": "Collection",
"parent": {
"uid": "b41ac545-d505-7014-edde-51bc4c0d21a0",
"singularName": "Full Control",
"pluralName": "User (Full Control)",
"fullName": "User (Full Control)",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": null,
"descendants": null,
"permissions": null
},
"descendants": [],
"permissions": [
{
"entityId": null,
"operationUID": "52f1b86c-46df-8fa4-5d75-f0c8702975e6",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2023-04-21T19:10:01.147Z"
},
{
"entityId": null,
"operationUID": "52f1b86c-46df-8fa4-5d75-f0c8702975e6",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.16Z"
},
{
"entityId": null,
"operationUID": "52f1b86c-46df-8fa4-5d75-f0c8702975e6",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.177Z"
},
{
"entityId": null,
"operationUID": "52f1b86c-46df-8fa4-5d75-f0c8702975e6",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.197Z"
},
{
"entityId": null,
"operationUID": "52f1b86c-46df-8fa4-5d75-f0c8702975e6",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.357Z"
},
{
"entityId": null,
"operationUID": "52f1b86c-46df-8fa4-5d75-f0c8702975e6",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.41Z"
}
]
},
{
"uid": "c244506f-4c57-4f66-88e0-ec2f05d06860",
"singularName": "Revoke Tokens",
"pluralName": "Revoke Tokens",
"fullName": "User (Full Control) - Revoke Tokens",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": {
"uid": "b41ac545-d505-7014-edde-51bc4c0d21a0",
"singularName": "Full Control",
"pluralName": "User (Full Control)",
"fullName": "User (Full Control)",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": null,
"descendants": null,
"permissions": null
},
"descendants": [],
"permissions": [
{
"entityId": null,
"operationUID": "c244506f-4c57-4f66-88e0-ec2f05d06860",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2023-04-21T19:10:01.147Z"
},
{
"entityId": null,
"operationUID": "c244506f-4c57-4f66-88e0-ec2f05d06860",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.16Z"
},
{
"entityId": null,
"operationUID": "c244506f-4c57-4f66-88e0-ec2f05d06860",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.177Z"
},
{
"entityId": null,
"operationUID": "c244506f-4c57-4f66-88e0-ec2f05d06860",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.197Z"
},
{
"entityId": null,
"operationUID": "c244506f-4c57-4f66-88e0-ec2f05d06860",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.357Z"
},
{
"entityId": null,
"operationUID": "c244506f-4c57-4f66-88e0-ec2f05d06860",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.41Z"
}
]
},
{
"uid": "51d92ebc-fb22-c4f4-093f-a737cba29ea8",
"singularName": "Lock User",
"pluralName": "Lock User",
"fullName": "User (Full Control) - Lock User",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": {
"uid": "b41ac545-d505-7014-edde-51bc4c0d21a0",
"singularName": "Full Control",
"pluralName": "User (Full Control)",
"fullName": "User (Full Control)",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": null,
"descendants": null,
"permissions": null
},
"descendants": [],
"permissions": [
{
"entityId": null,
"operationUID": "51d92ebc-fb22-c4f4-093f-a737cba29ea8",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2023-04-21T19:10:01.147Z"
},
{
"entityId": null,
"operationUID": "51d92ebc-fb22-c4f4-093f-a737cba29ea8",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.16Z"
},
{
"entityId": null,
"operationUID": "51d92ebc-fb22-c4f4-093f-a737cba29ea8",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.177Z"
},
{
"entityId": null,
"operationUID": "51d92ebc-fb22-c4f4-093f-a737cba29ea8",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.197Z"
},
{
"entityId": null,
"operationUID": "51d92ebc-fb22-c4f4-093f-a737cba29ea8",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.357Z"
},
{
"entityId": null,
"operationUID": "51d92ebc-fb22-c4f4-093f-a737cba29ea8",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.41Z"
}
]
},
{
"uid": "3f15e37b-449b-1b24-fd32-d113af0a798a",
"singularName": "Unlock User",
"pluralName": "Unlock User",
"fullName": "User (Full Control) - Unlock User",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": {
"uid": "b41ac545-d505-7014-edde-51bc4c0d21a0",
"singularName": "Full Control",
"pluralName": "User (Full Control)",
"fullName": "User (Full Control)",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": null,
"descendants": null,
"permissions": null
},
"descendants": [],
"permissions": [
{
"entityId": null,
"operationUID": "3f15e37b-449b-1b24-fd32-d113af0a798a",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2023-04-21T19:10:01.147Z"
},
{
"entityId": null,
"operationUID": "3f15e37b-449b-1b24-fd32-d113af0a798a",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.16Z"
},
{
"entityId": null,
"operationUID": "3f15e37b-449b-1b24-fd32-d113af0a798a",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.177Z"
},
{
"entityId": null,
"operationUID": "3f15e37b-449b-1b24-fd32-d113af0a798a",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.197Z"
},
{
"entityId": null,
"operationUID": "3f15e37b-449b-1b24-fd32-d113af0a798a",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.357Z"
},
{
"entityId": null,
"operationUID": "3f15e37b-449b-1b24-fd32-d113af0a798a",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.41Z"
}
]
},
{
"uid": "38b77fd8-16b6-9774-81e4-63af80fbbbb2",
"singularName": "Delete User",
"pluralName": "Delete User",
"fullName": "User (Full Control) - Delete User",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": {
"uid": "b41ac545-d505-7014-edde-51bc4c0d21a0",
"singularName": "Full Control",
"pluralName": "User (Full Control)",
"fullName": "User (Full Control)",
"targetEntity": "User",
"appliance": "Instance, Collection",
"parent": null,
"descendants": null,
"permissions": null
},
"descendants": [],
"permissions": [
{
"entityId": null,
"operationUID": "38b77fd8-16b6-9774-81e4-63af80fbbbb2",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": true,
"isAllowed": true,
"creationDate": "2023-04-21T19:10:01.147Z"
},
{
"entityId": null,
"operationUID": "38b77fd8-16b6-9774-81e4-63af80fbbbb2",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.16Z"
},
{
"entityId": null,
"operationUID": "38b77fd8-16b6-9774-81e4-63af80fbbbb2",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.177Z"
},
{
"entityId": null,
"operationUID": "38b77fd8-16b6-9774-81e4-63af80fbbbb2",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.197Z"
},
{
"entityId": null,
"operationUID": "38b77fd8-16b6-9774-81e4-63af80fbbbb2",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.357Z"
},
{
"entityId": null,
"operationUID": "38b77fd8-16b6-9774-81e4-63af80fbbbb2",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": true,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.41Z"
}
]
}
],
"permissions": [
{
"entityId": null,
"operationUID": "b41ac545-d505-7014-edde-51bc4c0d21a0",
"principal": {
"name": "Administrators",
"isCustom": false,
"type": "Role",
"id": 1
},
"isFixed": true,
"isInherited": false,
"isAllowed": true,
"creationDate": "2023-04-21T19:10:01.147Z"
},
{
"entityId": null,
"operationUID": "b41ac545-d505-7014-edde-51bc4c0d21a0",
"principal": {
"name": "General Managers",
"isCustom": false,
"type": "Role",
"id": 2
},
"isFixed": true,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.16Z"
},
{
"entityId": null,
"operationUID": "b41ac545-d505-7014-edde-51bc4c0d21a0",
"principal": {
"name": "Creators",
"isCustom": false,
"type": "Role",
"id": 3
},
"isFixed": true,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.177Z"
},
{
"entityId": null,
"operationUID": "b41ac545-d505-7014-edde-51bc4c0d21a0",
"principal": {
"name": "Publishers",
"isCustom": false,
"type": "Role",
"id": 4
},
"isFixed": true,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.197Z"
},
{
"entityId": null,
"operationUID": "b41ac545-d505-7014-edde-51bc4c0d21a0",
"principal": {
"name": "Network Managers",
"isCustom": false,
"type": "Role",
"id": 5
},
"isFixed": true,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.357Z"
},
{
"entityId": null,
"operationUID": "b41ac545-d505-7014-edde-51bc4c0d21a0",
"principal": {
"name": "Viewers",
"isCustom": false,
"type": "Role",
"id": 6
},
"isFixed": true,
"isInherited": false,
"isAllowed": false,
"creationDate": "2023-04-21T19:10:01.41Z"
}
]
}
```
:::
**Respuesta de error**
300: No se pudo devolver la representación solicitada porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque es válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
## GET /\{id}/Permissions/
Incluye permisos de objeto para un Usuario determinado
**Token de alcance requerido**
bsn.api.main.users.retrieve
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segmento**
- `id` int: Un identificador único para un Usuario
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- `id` se establece en `12345`
```text
GET /2022/06/REST/Users/12345/Permissions/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Cuerpo de la respuesta exitosa**
200: Devuelve una matriz de entidades de [Permiso](docId\:hc70CptqCOfQdZw2spAEK)
**Ejemplo**
```json
[
{
"entityId": 54321,
"operationUID": "67b9b0ab-fb5f-36c4-d598-a71aa8998e4e",
"principal": {
"login": "JaneDoe@brightsign.biz",
"type": "User",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2020-08-17T20:49:48.353Z"
}
]
```
**Respuesta de error**
300: No se pudo devolver la representación solicitada porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque es válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
## POST /\{id}/Permissions/
Agrega permisos para un Usuario especificado en una red
**Token de alcance requerido**
bsn.api.main.users.update
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segmento**
- `id` int: Un identificador único para un usuario
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Cuerpo de la solicitud**
- Una matriz de entidades [Permiso](docId\:hc70CptqCOfQdZw2spAEK)
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- `id` se establece en `12435`
```text
POST /2022/06/REST/Users/12345/Permissions/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 245
```
Este es el cuerpo de la solicitud de ejemplo:
```json
[
{
"entityId": 54321,
"operationUID": "c978aa8d-c7ac-410f-aec3-22e136d0ba58",
"principal": {
"login": "JaneDoe@brightsign.biZ",
"type": "User",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "0001-01-01T00:00:00"
}
]
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Respuesta correcta**
204: Los permisos se agregaron correctamente al usuario especificado
**Respuesta de error**
400: La solicitud o el cuerpo de la solicitud están mal formados y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
415: El servidor no puede aceptar la representación de datos que envió (según se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
## DELETE /\{id}/Permissions/
Elimina permisos para un usuario especificado en una red
**Token de ámbito requerido**
bsn.api.main.users.update
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segmento**
- `id` int: Un identificador único para un usuario
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Cuerpo de la solicitud**
- Una matriz de entidades [Permiso](docId\:hc70CptqCOfQdZw2spAEK) entidades
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- `id` se establece en `12345`
```text
DELETE /2022/06/REST/Users/12345/Permissions/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 245
```
Este es el cuerpo de la solicitud de ejemplo:
```json
[
{
"entityId": 54321,
"operationUID": "39e69897-8d9a-f634-95cf-7419a3e93c23",
"principal": {
"login": "JaneDoe@brightsign.biZ",
"type": "User",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "0001-01-01T00:00:00"
}
]
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Respuesta correcta**
204: Los permisos de User especificados se eliminaron correctamente
**Respuesta de error**
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tiene un formato incorrecto y, por lo tanto, no es válido, o se rechaza de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
## GET /\{login}/Permissions/
Incluye permisos de objetos para un User determinado
**Token de ámbito requerido**
bsn.api.main.users.retrieve
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segmento**
- `inicio de sesión` string: La información de inicio de sesión del User
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- `inicio de sesión` se establece en `JohnDoe@brightsign.biz`
```text
GET /2022/06/REST/Users/JohnDoe%40brightsign.biz/Permissions/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Cuerpo de la respuesta correcta**
200: Devuelve una matriz de entidades [Permiso](docId\:hc70CptqCOfQdZw2spAEK)
**Ejemplo**
```json
[
{
"entityId": 54321,
"operationUID": "67b9b0ab-fb5f-36c4-d598-a71aa8998e4e",
"principal": {
"login": "JohnDoe@brightsign.biz",
"type": "User",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "2020-08-17T20:49:48.353Z"
}
]
```
**Respuesta de error**
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
## POST /\{login}/Permissions/
Agrega permisos para un Usuario especificado en una red
**Token de Scope requerido**
bsn.api.main.users.update
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segmento**
- `inicio de sesión` string: La información de inicio de sesión del Usuario
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Cuerpo de la solicitud**
- Un arreglo de entidades [Permiso](docId\:hc70CptqCOfQdZw2spAEK)
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- `inicio de sesión` se establece en `JohnDoe@brightsign.biz`
```text
POST /2022/06/REST/Users/JohnDoe%40brightsign.biz/Permissions/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 322
```
Este es el cuerpo de la solicitud de ejemplo:
```json
[
{
"entityId": 54321,
"operationUID": "c978aa8d-c7ac-410f-aec3-22e136d0ba58",
"principal": {
"login": "JohnDoe@brightsign.biZ",
"type": "User",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "0001-01-01T00:00:00"
}
]
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Respuesta exitosa**
204: Los permisos se agregaron correctamente al Usuario especificado
**Respuesta de error**
400: La solicitud o el cuerpo de la solicitud tiene un formato incorrecto y, por lo tanto, no es válido, o se rechaza de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
415: El servidor no puede aceptar la representación de datos que usted envió (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
## DELETE /\{login}/Permissions/
Elimina permisos para un Usuario especificado en una red
**Token de Scope requerido**
bsn.api.main.users.update
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segmento**
- `inicio de sesión` string: La información de inicio de sesión del Usuario
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Cuerpo de la solicitud**
- Una matriz de entidades [Permiso](docId\:hc70CptqCOfQdZw2spAEK)
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- `inicio de sesión` se establece en `JohnDoe@brightsign.biz`
```text
DELETE /2022/06/REST/Users/JohnDoe%40brightsign.biz/Permissions/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 232
```
Este es el cuerpo de la solicitud de ejemplo:
```json
[
{
"entityId": 54321,
"operationUID": "39e69897-8d9a-f634-95cf-7419a3e93c23",
"principal": {
"login": "JohnDoe@brightsign.biZ",
"type": "User",
"id": 12345
},
"isFixed": false,
"isInherited": false,
"isAllowed": true,
"creationDate": "0001-01-01T00:00:00"
}
]
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Respuesta correcta**
204: Los permisos del User especificado se eliminaron correctamente
**Respuesta de error**
300: La representación solicitada no pudo devolverse porque es ambigua (hay varias representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso es inválido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
## GET /\{id}/Tokens/\{token}/
Valida el token de acceso o de actualización del usuario otorgado a un User especificado
**Token de Scope requerido**
bsn.api.main.users.token.validate
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segmentos**
- `id` int: Un identificador único para un User
- `token` string: Un token de acceso o actualización de User para una red BSN.Cloud
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- `id` se establece en `12345`
- `token` se establece en `{{UserAccessToken}}`
```text
GET /2022/06/REST/Users/12345/Tokens/{{UserAccessToken}}/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Cuerpo de la respuesta correcta**
200: Devuelve la [Entidad de información del token](docId\:enPl448_e5z_X8X0RQsGT)
**Ejemplo**
```json
{
"token": "{{UserAccessToken}}",
"scope": "add_device_setup bsn.api.main bsn.api.self bsn.api.upload bsn.ui.main player",
"validFrom": "2024-01-03T22:57:10Z",
"validTo": "2024-01-03T23:12:10Z"
}
```
**Respuesta de error**
300: No se pudo devolver la representación solicitada porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
## DELETE /\{id}/Tokens/\{token}/
Revoca los tokens de acceso o de actualización del usuario para el usuario especificado
**Token de scope requerido**
bsn.api.main.users.token.revoke
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segmentos**
- `id` int: Un identificador único para un usuario
- `token` string: El token de acceso o de actualización del usuario para usar con esta llamada de endpoint
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- `id` se establece en `12345`
- `token` se establece en `{{UserAccessToken}}`
```text
DELETE /2022/06/REST/Users/12345/Tokens/{{UserAccessToken}}/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Respuesta exitosa**
204: El token de acceso o de actualización del usuario se ha revocado correctamente del usuario especificado
**Respuesta de error**
300: No se pudo devolver la representación solicitada porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tiene un formato incorrecto y, por lo tanto, no es válido, o se rechaza de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El token especificado no es válido, ha expirado o ha sido revocado, o se emitió para otro usuario
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
## GET /\{login}/Tokens/\{token}/
Valida el token de acceso o actualización del usuario otorgado al usuario especificado
**Token de alcance requerido**
bsn.api.main.users.token.validate
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segmentos**
- `inicio de sesión` string: El login de un usuario
- `token` string: Un token de acceso o actualización de usuario para una red BSN.Cloud
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- `inicio de sesión` se establece en `JohnDoe@brightsign.biz`
- `token` se establece en `{{UserAccessToken}}`
```text
GET /2022/06/REST/Users/JohnDoe%40brightsign.biz/Tokens/{{UserAccessToken}}/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Cuerpo de la respuesta exitosa**
200: Devuelve la [Entidad de información del token](docId\:enPl448_e5z_X8X0RQsGT)
**Ejemplo**
```json
{
"token": "{{UserAccessToken}}",
"scope": "add_device_setup bsn.api.main bsn.api.self bsn.api.upload bsn.ui.main player",
"validFrom": "2024-01-03T22:57:10Z",
"validTo": "2024-01-03T23:12:10Z"
}
```
**Respuesta de error**
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud tiene un formato incorrecto y por lo tanto no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado (la ruta no existe)
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
## DELETE /\{login}/Tokens/\{token}/
Revoca el token de acceso o actualización del usuario otorgado al usuario especificado
**Token de alcance requerido**
bsn.api.main.users.token.revoke
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Segmentos**
- `inicio de sesión` string: El login de un usuario
- `token` string: Un token de acceso o actualización de usuario para una red BSN.cloud
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Ejemplo de solicitud**
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- `inicio de sesión` se establece en `JohnDoe@brightsign.biz`
- `token` se establece en `{{UserAccessToken}}`
```text
DELETE /2022/06/REST/Users/JohnDoe%40brightsign.biz/Tokens/{{UserAccessToken}}/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
```
\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
**Respuesta exitosa**
204: El token de acceso o de actualización del usuario se ha revocado correctamente del usuario especificado
**Respuesta de error**
300: No se pudo devolver la representación solicitada porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El token especificado no es válido, ha expirado o fue revocado, o fue emitido para otro usuario
406: El servidor no puede devolver la representación de datos que solicitó (según lo especificado en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor