Endpoints de roles (2022/06)

42 min

Estos endpoints permiten a los usuarios administrar roles en una red.

URL base para estos endpoints: https://api.bsn.cloud/2022/06/REST/Roles

_________________________________________________________________________

GET /

Devuelve una lista de roles en una red

Token de Scope requerido

bsn.api.main.roles.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 en el cuerpo de respuesta de la llamada GET anterior indica que la cantidad de instancias de roles excede el pageSize. Este parámetro solo es requerido si necesita más elementos en la lista paginada que el pageSize (100).
pageSize int opcional: La cantidad máxima de instancias de roles que pueden incluirse en el cuerpo de respuesta. De forma predeterminada, esto utiliza 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 el valor 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

GET /2022/06/REST/Roles/?marker=4kfak45jfk0915NVe&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 exitoso

200: Devuelve una lista paginadalista paginada de instancias de Entidad de rol 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

{
  "items": [
    {
      "id": 12345,
      "isCustom": true,
      "name": "Custom Role 20231115",
      "description": "",
      "creationDate": "2023-11-15T19:14:10.087Z",
      "userCount": 0,
      "users": null,
      "permissions": [
        {
          "entityId": null,
          "operationUID": "d430853f-c05f-61b4-d137-0237a6984032",
          "principal": {
            "name": "Custom Role 20231115",
            "isCustom": true,
            "type": "Role",
            "id": 12345
          },
          "isFixed": false,
          "isInherited": false,
          "isAllowed": false,
          "creationDate": "2023-11-15T19:14:10.097Z"
        }
      ]
    }
  ],
  "totalItemCount": 8,
  "matchingItemCount": 8,
  "pageSize": 1,
  "nextMarker": "Cu20afjksdUN78q932",
  "prevMarker": "Cu20afjksdUN7813rf",
  "isTruncated": true,
  "sortExpression": "[Role].[Name] 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 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ó (como se especifica en el encabezado "Accept")

5XX: Cualquier código 500 es un error interno del servidor

POST /

Crea un rol en una red

Token de alcance requerido

bsn.api.main.roles.create

______________________________________________________________

Cuerpo de la solicitud

La Entidad de rol

______________________________________________________________

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:

POST /2022/06/REST/Roles/ 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: 962

Este es el cuerpo de la solicitud de ejemplo:

{
   "id": 0,
   "isCustom": true,
   "name": "Custom Role 20231115",
   "description": "",
   "creationDate": "0001-01-01T00:00:00",
   "userCount": 0,
   "users": null,
   "permissions": []
}

______________________________________________________________

Cuerpo de la respuesta exitosa

201: Devuelve la Entidad de rol creada y referenciada por el Uri (proporcionado por el campo de encabezado Location) en la respuesta.

Ejemplo

{
   "id": 12345,
   "isCustom": true,
   "name": "Custom Role 20231115",
   "description": "",
   "creationDate": "2023-11-15T19:14:10.087Z",
   "userCount": 0,
   "users": null,
   "permissions": []
}

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ó (como se especifica en el encabezado "Accept")

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

GET /{id}/

Devuelve un rol especificado en una red

Token de alcance requerido

bsn.api.main.roles.retrieve

______________________________________________________________

Segmento

id int: Un identificador único para un rol

______________________________________________________________

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:

id se establece en 12345

GET /2022/06/REST/Roles/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

______________________________________________________________

Respuesta correcta con cuerpo

200: Devuelve la Entidad de rol

Ejemplo

Este es un ejemplo de una respuesta de nivel 200:

{
  "id": 12345,
  "isCustom": true,
  "name": "Custom Role 20231115",
  "description": "",
  "creationDate": "2023-11-15T19:14:10.087Z",
  "userCount": 1,
  "users": [
    {
      "login": "[email protected]",
      "type": "User",
      "id": 54321
    }
  ],
  "permissions": [
    {
      "entityId": null,
      "operationUID": "3a67ae65-aa94-477b-acab-5291347cef2c",
      "principal": {
        "name": "Custom Role 20231115",
        "isCustom": true,
        "type": "Role",
        "id": 12345
      },
      "isFixed": false,
      "isInherited": false,
      "isAllowed": false,
      "creationDate": "2023-12-01T16:37:19.553Z"
    }
  ]
}

Respuesta de error

300: No se pudo devolver la representación solicitada porque es ambigua (hay varias 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 /{id}/

Actualiza el rol especificado en una red

Token de alcance requerido

bsn.api.main.roles.update

______________________________________________________________

Segmento

id int: Un identificador único para un rol

______________________________________________________________

Cuerpo de la solicitud

La Entidad de rol

______________________________________________________________

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:

id se establece en 12345

PUT /2022/06/REST/Roles/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
Content-Type: application/json
Content-Length: 756

Este es el cuerpo de solicitud de ejemplo:

{
   "id": 0,
   "isCustom": true,
   "name": "Custom Role 20231115",
   "description": "",
   "creationDate": "0001-01-01T00:00:00",
   "userCount": 0,
   "users": null,
   "permissions": [
    {
      "entityId": null,
      "operationUID": "3a67ae65-aa94-477b-acab-5291347cef2c",
      "principal": {
        "name": "Custom Role 20231115",
        "isCustom": true,
        "type": "Role",
        "id": 12345
      },
      "isFixed": false,
      "isInherited": false,
      "isAllowed": false,
      "creationDate": "0001-01-01T00:00:00"
    }
  ]
}

______________________________________________________________

Respuesta correcta

204: El rol se actualizó correctamente.

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, son invá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 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

DELETE /{id}/

Elimina el rol personalizado especificado en una red

Token de alcance requerido

bsn.api.main.roles.delete

______________________________________________________________

Segmento

id int: Un identificador único para un rol personalizado

______________________________________________________________

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:

id se establece en 12345

DELETE /2022/06/REST/Roles/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

______________________________________________________________

Respuesta correcta

204: El rol especificado ha sido eliminado

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, son inválidos, o se rechazan de acuerdo con las reglas de negocio (por ejemplo, si el usuario intenta eliminar un rol del sistema).

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 /{name}/

Devuelve el rol especificado en una red

Token de alcance requerido

bsn.api.main.roles.retrieve

______________________________________________________________

Segmento

nombre string: El nombre del rol

______________________________________________________________

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:

nombre se establece en Rol personalizado 20231115

GET /2022/06/REST/Roles/Custom Role 20231115/ 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 correcta con cuerpo

200: Devuelve la Entidad de rol

Ejemplo

Este es un ejemplo de una respuesta de nivel 200:

{
  "id": 12345,
  "isCustom": true,
  "name": "Custom Role 20231115",
  "description": "",
  "creationDate": "2023-11-15T19:14:10.087Z",
  "userCount": 1,
  "users": [
    {
      "login": "[email protected]",
      "type": "User",
      "id": 54321
    }
  ],
  "permissions": [
    {
      "entityId": null,
      "operationUID": "3a67ae65-aa94-477b-acab-5291347cef2c",
      "principal": {
        "name": "Custom Role 20231115",
        "isCustom": true,
        "type": "Role",
        "id": 12345
      },
      "isFixed": false,
      "isInherited": false,
      "isAllowed": false,
      "creationDate": "2023-12-01T16:37:19.553Z"
    }
  ]
}

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

PUT /{name}/

Actualiza el rol especificado en una red

Token de alcance requerido

bsn.api.main.roles.update

______________________________________________________________

Segmento

nombre string: El nombre del rol

______________________________________________________________

Cuerpo de la solicitud

La Entidad de rol

______________________________________________________________

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:

nombre se establece en Rol personalizado 20231115

PUT /2022/06/REST/Roles/Custom Role 20231115/ 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: 756

Este es el cuerpo de la solicitud de ejemplo:

{
   "id": 0,
   "isCustom": true,
   "name": "Custom Role 20231115",
   "description": "",
   "creationDate": "0001-01-01T00:00:00",
   "userCount": 0,
   "users": null,
   "permissions": [
    {
      "entityId": null,
      "operationUID": "3a67ae65-aa94-477b-acab-5291347cef2c",
      "principal": {
        "name": "Custom Role 20231115",
        "isCustom": true,
        "type": "Role",
        "id": 12345
      },
      "isFixed": false,
      "isInherited": false,
      "isAllowed": false,
      "creationDate": "0001-01-01T00:00:00"
    }
  ]
}

______________________________________________________________

Respuesta correcta

204: El rol se actualizó 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 tienen un formato incorrecto y, por lo tanto, son invá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 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

DELETE /{name}/

Elimina el rol personalizado especificado en una red

Token de alcance requerido

bsn.api.main.roles.delete

______________________________________________________________

Segmento

nombre string: El nombre del rol personalizado

______________________________________________________________

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:

nombre se establece en Rol personalizado 20231116

DELETE /2022/06/REST/Roles/Custom Role 20231116/ 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 correcta

204: El rol especificado ha sido eliminado

Respuesta de error

300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)

400: La solicitud está mal formada y, por lo tanto, no es válida, o se rechaza de acuerdo con las reglas de negocio (por ejemplo, si el usuario intenta eliminar un rol del sistema).

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

GET /Operations/

Devuelve permisos operativos otorgados a roles para operaciones empresariales 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 configuran de la siguiente manera:

GET /2022/06/REST/Roles/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 empresarialesBusiness Operations Entity

{
  "uid": "027a307a-a29d-d674-a935-da468ef03091",
  "singularName": "Full Control",
  "pluralName": "Role (Full Control)",
  "fullName": "Role (Full Control)",
  "targetEntity": "Role",
  "appliance": "Instance, Collection",
  "parent": null,
  "descendants": [
    {
      "uid": "0b943c8f-f889-2074-f152-014cff8c2e5d",
      "singularName": "View Role",
      "pluralName": "View Roles",
      "fullName": "Role (Full Control) - View Roles",
      "targetEntity": "Role",
      "appliance": "Instance, Collection",
      "parent": {
        "uid": "027a307a-a29d-d674-a935-da468ef03091",
        "singularName": "Full Control",
        "pluralName": "Role (Full Control)",
        "fullName": "Role (Full Control)",
        "targetEntity": "Role",
        "appliance": "Instance, Collection",
        "parent": null,
        "descendants": null,
        "permissions": null
      },
      "descendants": [],
      "permissions": [
        {
          "entityId": null,
          "operationUID": "0b943c8f-f889-2074-f152-014cff8c2e5d",
          "principal": {
            "name": "Administrators",
            "isCustom": false,
            "type": "Role",
            "id": 1
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": true,
          "creationDate": "2024-01-03T01:44:13.16Z"
        },
        {
          "entityId": null,
          "operationUID": "0b943c8f-f889-2074-f152-014cff8c2e5d",
          "principal": {
            "name": "General Managers",
            "isCustom": false,
            "type": "Role",
            "id": 2
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.283Z"
        },
        {
          "entityId": null,
          "operationUID": "0b943c8f-f889-2074-f152-014cff8c2e5d",
          "principal": {
            "name": "Creators",
            "isCustom": false,
            "type": "Role",
            "id": 3
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.38Z"
        },
        {
          "entityId": null,
          "operationUID": "0b943c8f-f889-2074-f152-014cff8c2e5d",
          "principal": {
            "name": "Publishers",
            "isCustom": false,
            "type": "Role",
            "id": 4
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.45Z"
        },
        {
          "entityId": null,
          "operationUID": "0b943c8f-f889-2074-f152-014cff8c2e5d",
          "principal": {
            "name": "Network Managers",
            "isCustom": false,
            "type": "Role",
            "id": 5
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.62Z"
        },
        {
          "entityId": null,
          "operationUID": "0b943c8f-f889-2074-f152-014cff8c2e5d",
          "principal": {
            "name": "Viewers",
            "isCustom": false,
            "type": "Role",
            "id": 6
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.803Z"
        }
      ]
    },
    {
      "uid": "f7d768be-c485-b4d4-5d98-bc80c329922c",
      "singularName": "View Users",
      "pluralName": "View Users",
      "fullName": "Role (Full Control) - View Users",
      "targetEntity": "Role",
      "appliance": "Instance, Collection",
      "parent": {
        "uid": "027a307a-a29d-d674-a935-da468ef03091",
        "singularName": "Full Control",
        "pluralName": "Role (Full Control)",
        "fullName": "Role (Full Control)",
        "targetEntity": "Role",
        "appliance": "Instance, Collection",
        "parent": null,
        "descendants": null,
        "permissions": null
      },
      "descendants": [],
      "permissions": [
        {
          "entityId": null,
          "operationUID": "f7d768be-c485-b4d4-5d98-bc80c329922c",
          "principal": {
            "name": "Administrators",
            "isCustom": false,
            "type": "Role",
            "id": 1
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": true,
          "creationDate": "2024-01-03T01:44:13.16Z"
        },
        {
          "entityId": null,
          "operationUID": "f7d768be-c485-b4d4-5d98-bc80c329922c",
          "principal": {
            "name": "General Managers",
            "isCustom": false,
            "type": "Role",
            "id": 2
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.283Z"
        },
        {
          "entityId": null,
          "operationUID": "f7d768be-c485-b4d4-5d98-bc80c329922c",
          "principal": {
            "name": "Creators",
            "isCustom": false,
            "type": "Role",
            "id": 3
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.38Z"
        },
        {
          "entityId": null,
          "operationUID": "f7d768be-c485-b4d4-5d98-bc80c329922c",
          "principal": {
            "name": "Publishers",
            "isCustom": false,
            "type": "Role",
            "id": 4
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.45Z"
        },
        {
          "entityId": null,
          "operationUID": "f7d768be-c485-b4d4-5d98-bc80c329922c",
          "principal": {
            "name": "Network Managers",
            "isCustom": false,
            "type": "Role",
            "id": 5
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.62Z"
        },
        {
          "entityId": null,
          "operationUID": "f7d768be-c485-b4d4-5d98-bc80c329922c",
          "principal": {
            "name": "Viewers",
            "isCustom": false,
            "type": "Role",
            "id": 6
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.803Z"
        }
      ]
    },
    {
      "uid": "f2293374-b9bb-2a04-b192-e1e3fb9b013a",
      "singularName": "Create Role",
      "pluralName": "Create Role",
      "fullName": "Role (Full Control) - Create Role",
      "targetEntity": "Role",
      "appliance": "Instance, Collection",
      "parent": {
        "uid": "027a307a-a29d-d674-a935-da468ef03091",
        "singularName": "Full Control",
        "pluralName": "Role (Full Control)",
        "fullName": "Role (Full Control)",
        "targetEntity": "Role",
        "appliance": "Instance, Collection",
        "parent": null,
        "descendants": null,
        "permissions": null
      },
      "descendants": [],
      "permissions": [
        {
          "entityId": null,
          "operationUID": "f2293374-b9bb-2a04-b192-e1e3fb9b013a",
          "principal": {
            "name": "Administrators",
            "isCustom": false,
            "type": "Role",
            "id": 1
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": true,
          "creationDate": "2024-01-03T01:44:13.16Z"
        },
        {
          "entityId": null,
          "operationUID": "f2293374-b9bb-2a04-b192-e1e3fb9b013a",
          "principal": {
            "name": "General Managers",
            "isCustom": false,
            "type": "Role",
            "id": 2
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.283Z"
        },
        {
          "entityId": null,
          "operationUID": "f2293374-b9bb-2a04-b192-e1e3fb9b013a",
          "principal": {
            "name": "Creators",
            "isCustom": false,
            "type": "Role",
            "id": 3
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.38Z"
        },
        {
          "entityId": null,
          "operationUID": "f2293374-b9bb-2a04-b192-e1e3fb9b013a",
          "principal": {
            "name": "Publishers",
            "isCustom": false,
            "type": "Role",
            "id": 4
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.45Z"
        },
        {
          "entityId": null,
          "operationUID": "f2293374-b9bb-2a04-b192-e1e3fb9b013a",
          "principal": {
            "name": "Network Managers",
            "isCustom": false,
            "type": "Role",
            "id": 5
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.62Z"
        },
        {
          "entityId": null,
          "operationUID": "f2293374-b9bb-2a04-b192-e1e3fb9b013a",
          "principal": {
            "name": "Viewers",
            "isCustom": false,
            "type": "Role",
            "id": 6
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.803Z"
        }
      ]
    },
    {
      "uid": "5cd2960f-5361-a504-81bf-9496384d1c24",
      "singularName": "Add User",
      "pluralName": "Add User",
      "fullName": "Role (Full Control) - Add User",
      "targetEntity": "Role",
      "appliance": "Instance, Collection",
      "parent": {
        "uid": "027a307a-a29d-d674-a935-da468ef03091",
        "singularName": "Full Control",
        "pluralName": "Role (Full Control)",
        "fullName": "Role (Full Control)",
        "targetEntity": "Role",
        "appliance": "Instance, Collection",
        "parent": null,
        "descendants": null,
        "permissions": null
      },
      "descendants": [],
      "permissions": [
        {
          "entityId": null,
          "operationUID": "5cd2960f-5361-a504-81bf-9496384d1c24",
          "principal": {
            "name": "Administrators",
            "isCustom": false,
            "type": "Role",
            "id": 1
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": true,
          "creationDate": "2024-01-03T01:44:13.16Z"
        },
        {
          "entityId": null,
          "operationUID": "5cd2960f-5361-a504-81bf-9496384d1c24",
          "principal": {
            "name": "General Managers",
            "isCustom": false,
            "type": "Role",
            "id": 2
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.283Z"
        },
        {
          "entityId": null,
          "operationUID": "5cd2960f-5361-a504-81bf-9496384d1c24",
          "principal": {
            "name": "Creators",
            "isCustom": false,
            "type": "Role",
            "id": 3
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.38Z"
        },
        {
          "entityId": null,
          "operationUID": "5cd2960f-5361-a504-81bf-9496384d1c24",
          "principal": {
            "name": "Publishers",
            "isCustom": false,
            "type": "Role",
            "id": 4
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.45Z"
        },
        {
          "entityId": null,
          "operationUID": "5cd2960f-5361-a504-81bf-9496384d1c24",
          "principal": {
            "name": "Network Managers",
            "isCustom": false,
            "type": "Role",
            "id": 5
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.62Z"
        },
        {
          "entityId": null,
          "operationUID": "5cd2960f-5361-a504-81bf-9496384d1c24",
          "principal": {
            "name": "Viewers",
            "isCustom": false,
            "type": "Role",
            "id": 6
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.803Z"
        }
      ]
    },
    {
      "uid": "a81a32c6-4291-05c4-71a2-6f899dc6da15",
      "singularName": "Remove User",
      "pluralName": "Remove User",
      "fullName": "Role (Full Control) - Remove User",
      "targetEntity": "Role",
      "appliance": "Instance, Collection",
      "parent": {
        "uid": "027a307a-a29d-d674-a935-da468ef03091",
        "singularName": "Full Control",
        "pluralName": "Role (Full Control)",
        "fullName": "Role (Full Control)",
        "targetEntity": "Role",
        "appliance": "Instance, Collection",
        "parent": null,
        "descendants": null,
        "permissions": null
      },
      "descendants": [],
      "permissions": [
        {
          "entityId": null,
          "operationUID": "a81a32c6-4291-05c4-71a2-6f899dc6da15",
          "principal": {
            "name": "Administrators",
            "isCustom": false,
            "type": "Role",
            "id": 1
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": true,
          "creationDate": "2024-01-03T01:44:13.16Z"
        },
        {
          "entityId": null,
          "operationUID": "a81a32c6-4291-05c4-71a2-6f899dc6da15",
          "principal": {
            "name": "General Managers",
            "isCustom": false,
            "type": "Role",
            "id": 2
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.283Z"
        },
        {
          "entityId": null,
          "operationUID": "a81a32c6-4291-05c4-71a2-6f899dc6da15",
          "principal": {
            "name": "Creators",
            "isCustom": false,
            "type": "Role",
            "id": 3
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.38Z"
        },
        {
          "entityId": null,
          "operationUID": "a81a32c6-4291-05c4-71a2-6f899dc6da15",
          "principal": {
            "name": "Publishers",
            "isCustom": false,
            "type": "Role",
            "id": 4
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.45Z"
        },
        {
          "entityId": null,
          "operationUID": "a81a32c6-4291-05c4-71a2-6f899dc6da15",
          "principal": {
            "name": "Network Managers",
            "isCustom": false,
            "type": "Role",
            "id": 5
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.62Z"
        },
        {
          "entityId": null,
          "operationUID": "a81a32c6-4291-05c4-71a2-6f899dc6da15",
          "principal": {
            "name": "Viewers",
            "isCustom": false,
            "type": "Role",
            "id": 6
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.803Z"
        }
      ]
    },
    {
      "uid": "b38189a5-84d8-fba4-bd56-f71a5dfba6e6",
      "singularName": "Edit Permissions",
      "pluralName": "Edit Permissions",
      "fullName": "Role (Full Control) - Edit Permissions",
      "targetEntity": "Role",
      "appliance": "Collection",
      "parent": {
        "uid": "027a307a-a29d-d674-a935-da468ef03091",
        "singularName": "Full Control",
        "pluralName": "Role (Full Control)",
        "fullName": "Role (Full Control)",
        "targetEntity": "Role",
        "appliance": "Instance, Collection",
        "parent": null,
        "descendants": null,
        "permissions": null
      },
      "descendants": [],
      "permissions": [
        {
          "entityId": null,
          "operationUID": "b38189a5-84d8-fba4-bd56-f71a5dfba6e6",
          "principal": {
            "name": "Administrators",
            "isCustom": false,
            "type": "Role",
            "id": 1
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": true,
          "creationDate": "2024-01-03T01:44:13.16Z"
        },
        {
          "entityId": null,
          "operationUID": "b38189a5-84d8-fba4-bd56-f71a5dfba6e6",
          "principal": {
            "name": "General Managers",
            "isCustom": false,
            "type": "Role",
            "id": 2
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.283Z"
        },
        {
          "entityId": null,
          "operationUID": "b38189a5-84d8-fba4-bd56-f71a5dfba6e6",
          "principal": {
            "name": "Creators",
            "isCustom": false,
            "type": "Role",
            "id": 3
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.38Z"
        },
        {
          "entityId": null,
          "operationUID": "b38189a5-84d8-fba4-bd56-f71a5dfba6e6",
          "principal": {
            "name": "Publishers",
            "isCustom": false,
            "type": "Role",
            "id": 4
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.45Z"
        },
        {
          "entityId": null,
          "operationUID": "b38189a5-84d8-fba4-bd56-f71a5dfba6e6",
          "principal": {
            "name": "Network Managers",
            "isCustom": false,
            "type": "Role",
            "id": 5
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.62Z"
        },
        {
          "entityId": null,
          "operationUID": "b38189a5-84d8-fba4-bd56-f71a5dfba6e6",
          "principal": {
            "name": "Viewers",
            "isCustom": false,
            "type": "Role",
            "id": 6
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.803Z"
        }
      ]
    },
    {
      "uid": "0a9b49c6-74a4-2834-15c6-606964e01f8b",
      "singularName": "Update Role",
      "pluralName": "Update Role",
      "fullName": "Role (Full Control) - Update Role",
      "targetEntity": "Role",
      "appliance": "Collection",
      "parent": {
        "uid": "027a307a-a29d-d674-a935-da468ef03091",
        "singularName": "Full Control",
        "pluralName": "Role (Full Control)",
        "fullName": "Role (Full Control)",
        "targetEntity": "Role",
        "appliance": "Instance, Collection",
        "parent": null,
        "descendants": null,
        "permissions": null
      },
      "descendants": [],
      "permissions": [
        {
          "entityId": null,
          "operationUID": "0a9b49c6-74a4-2834-15c6-606964e01f8b",
          "principal": {
            "name": "Administrators",
            "isCustom": false,
            "type": "Role",
            "id": 1
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": true,
          "creationDate": "2024-01-03T01:44:13.16Z"
        },
        {
          "entityId": null,
          "operationUID": "0a9b49c6-74a4-2834-15c6-606964e01f8b",
          "principal": {
            "name": "General Managers",
            "isCustom": false,
            "type": "Role",
            "id": 2
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.283Z"
        },
        {
          "entityId": null,
          "operationUID": "0a9b49c6-74a4-2834-15c6-606964e01f8b",
          "principal": {
            "name": "Creators",
            "isCustom": false,
            "type": "Role",
            "id": 3
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.38Z"
        },
        {
          "entityId": null,
          "operationUID": "0a9b49c6-74a4-2834-15c6-606964e01f8b",
          "principal": {
            "name": "Publishers",
            "isCustom": false,
            "type": "Role",
            "id": 4
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.45Z"
        },
        {
          "entityId": null,
          "operationUID": "0a9b49c6-74a4-2834-15c6-606964e01f8b",
          "principal": {
            "name": "Network Managers",
            "isCustom": false,
            "type": "Role",
            "id": 5
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.62Z"
        },
        {
          "entityId": null,
          "operationUID": "0a9b49c6-74a4-2834-15c6-606964e01f8b",
          "principal": {
            "name": "Viewers",
            "isCustom": false,
            "type": "Role",
            "id": 6
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.803Z"
        }
      ]
    },
    {
      "uid": "30af3135-5514-2f64-75e1-d31e074c16d5",
      "singularName": "Delete Role",
      "pluralName": "Delete Role",
      "fullName": "Role (Full Control) - Delete Role",
      "targetEntity": "Role",
      "appliance": "Instance, Collection",
      "parent": {
        "uid": "027a307a-a29d-d674-a935-da468ef03091",
        "singularName": "Full Control",
        "pluralName": "Role (Full Control)",
        "fullName": "Role (Full Control)",
        "targetEntity": "Role",
        "appliance": "Instance, Collection",
        "parent": null,
        "descendants": null,
        "permissions": null
      },
      "descendants": [],
      "permissions": [
        {
          "entityId": null,
          "operationUID": "30af3135-5514-2f64-75e1-d31e074c16d5",
          "principal": {
            "name": "Administrators",
            "isCustom": false,
            "type": "Role",
            "id": 1
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": true,
          "creationDate": "2024-01-03T01:44:13.16Z"
        },
        {
          "entityId": null,
          "operationUID": "30af3135-5514-2f64-75e1-d31e074c16d5",
          "principal": {
            "name": "General Managers",
            "isCustom": false,
            "type": "Role",
            "id": 2
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.283Z"
        },
        {
          "entityId": null,
          "operationUID": "30af3135-5514-2f64-75e1-d31e074c16d5",
          "principal": {
            "name": "Creators",
            "isCustom": false,
            "type": "Role",
            "id": 3
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.38Z"
        },
        {
          "entityId": null,
          "operationUID": "30af3135-5514-2f64-75e1-d31e074c16d5",
          "principal": {
            "name": "Publishers",
            "isCustom": false,
            "type": "Role",
            "id": 4
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.45Z"
        },
        {
          "entityId": null,
          "operationUID": "30af3135-5514-2f64-75e1-d31e074c16d5",
          "principal": {
            "name": "Network Managers",
            "isCustom": false,
            "type": "Role",
            "id": 5
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.62Z"
        },
        {
          "entityId": null,
          "operationUID": "30af3135-5514-2f64-75e1-d31e074c16d5",
          "principal": {
            "name": "Viewers",
            "isCustom": false,
            "type": "Role",
            "id": 6
          },
          "isFixed": true,
          "isInherited": true,
          "isAllowed": false,
          "creationDate": "2024-01-03T01:44:13.803Z"
        }
      ]
    }
  ],
  "permissions": [
    {
      "entityId": null,
      "operationUID": "027a307a-a29d-d674-a935-da468ef03091",
      "principal": {
        "name": "Administrators",
        "isCustom": false,
        "type": "Role",
        "id": 1
      },
      "isFixed": true,
      "isInherited": false,
      "isAllowed": true,
      "creationDate": "2024-01-03T01:44:13.16Z"
    },
    {
      "entityId": null,
      "operationUID": "027a307a-a29d-d674-a935-da468ef03091",
      "principal": {
        "name": "General Managers",
        "isCustom": false,
        "type": "Role",
        "id": 2
      },
      "isFixed": true,
      "isInherited": false,
      "isAllowed": false,
      "creationDate": "2024-01-03T01:44:13.283Z"
    },
    {
      "entityId": null,
      "operationUID": "027a307a-a29d-d674-a935-da468ef03091",
      "principal": {
        "name": "Creators",
        "isCustom": false,
        "type": "Role",
        "id": 3
      },
      "isFixed": true,
      "isInherited": false,
      "isAllowed": false,
      "creationDate": "2024-01-03T01:44:13.38Z"
    },
    {
      "entityId": null,
      "operationUID": "027a307a-a29d-d674-a935-da468ef03091",
      "principal": {
        "name": "Publishers",
        "isCustom": false,
        "type": "Role",
        "id": 4
      },
      "isFixed": true,
      "isInherited": false,
      "isAllowed": false,
      "creationDate": "2024-01-03T01:44:13.45Z"
    },
    {
      "entityId": null,
      "operationUID": "027a307a-a29d-d674-a935-da468ef03091",
      "principal": {
        "name": "Network Managers",
        "isCustom": false,
        "type": "Role",
        "id": 5
      },
      "isFixed": true,
      "isInherited": false,
      "isAllowed": false,
      "creationDate": "2024-01-03T01:44:13.62Z"
    },
    {
      "entityId": null,
      "operationUID": "027a307a-a29d-d674-a935-da468ef03091",
      "principal": {
        "name": "Viewers",
        "isCustom": false,
        "type": "Role",
        "id": 6
      },
      "isFixed": true,
      "isInherited": false,
      "isAllowed": false,
      "creationDate": "2024-01-03T01:44:13.803Z"
    }
  ]
}

Respuesta de error

300: La representación solicitada no pudo devolverse 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 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 otorgados a un rol determinado

Token de alcance requerido

bsn.api.main.roles.retrieve

______________________________________________________________

Segmento

id int: Un identificador único para un rol

______________________________________________________________

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:

id se establece en 12345

GET /2022/06/REST/Roles/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 PermisoPermission otorgadas a un rol determinado

Ejemplo

[
  {
    "entityId": null,
    "operationUID": "b41ac545-d505-7014-edde-51bc4c0d21a0",
    "principal": {
      "name": "Creators",
      "isCustom": false,
      "type": "Role",
      "id": 12345
    },
    "isFixed": true,
    "isInherited": false,
    "isAllowed": false,
    "creationDate": "2020-08-17T20:49:46.35Z"
  }
]

Respuesta de error

300: La representación solicitada no pudo devolverse 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 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/

Agregar permisos para roles especificados en una red

Token de alcance requerido

bsn.api.main.roles.update

______________________________________________________________

Segmento

id int: Un identificador único para un rol

______________________________________________________________

Cuerpo de la solicitud

Una matriz de PermisoPermission 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

POST /2022/06/REST/Roles/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: 292

Este es el cuerpo de la solicitud de ejemplo:

{
  "entityId": null,
  "operationUID": "b41ac545-d505-7014-edde-51bc4c0d21a0",
  "principal": {
    "name": "Creators",
    "isCustom": false,
    "type": "Role",
    "id": 12345
  },
  "isFixed": false,
  "isInherited": false,
  "isAllowed": false,
  "creationDate": "0001-01-01T00:00:00"
}

______________________________________________________________

Respuesta correcta

204: Los permisos se agregaron correctamente al rol 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 comerciales

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ó (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 roles especificados en una red

Token de alcance requerido

bsn.api.main.roles.delete

______________________________________________________________

Segmento

id int: Un identificador único para un rol

______________________________________________________________

Cuerpo de la solicitud

Una matriz de PermisoPermission 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

DELETE /2022/06/REST/Roles/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: 359

Este es el cuerpo de solicitud de ejemplo:

{
  "entityId": null,
  "operationUID": "b41ac545-d505-7014-edde-51bc4c0d21a0",
  "principal": {
    "name": "Creators",
    "isCustom": false,
    "type": "Role",
    "id": 12345
  },
  "isFixed": false,
  "isInherited": false,
  "isAllowed": false,
  "creationDate": "0001-01-01T00:00:00"
}

______________________________________________________________

Respuesta correcta

204: Los permisos especificados se han eliminado del rol

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 ha 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 solicitó (según lo especificado en el encabezado "Accept")

5XX: Cualquier código 500 es un error interno del servidor

GET /{name}/Permissions/

Incluye permisos de objetos otorgados a un rol determinado.

Token de alcance requerido

bsn.api.main.roles.retrieve

______________________________________________________________

Segmento

nombre string: El nombre del rol

______________________________________________________________

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:

nombre se establece en Creadores

GET /2022/06/REST/Roles/Creators/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 respuesta correcta

200: Devuelve una matriz de entidades PermisoPermission otorgadas a un rol determinado

Ejemplo

[
  {
    "entityId": null,
    "operationUID": "b41ac545-d505-7014-edde-51bc4c0d21a0",
    "principal": {
      "name": "Creators",
      "isCustom": false,
      "type": "Role",
      "id": 12345
    },
    "isFixed": true,
    "isInherited": false,
    "isAllowed": false,
    "creationDate": "2020-08-17T20:49:46.35Z"
  }
]

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 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

POST /{name}/Permissions/

Agrega permisos para roles especificados en una red

Token de Scope requerido

bsn.api.main.roles.update

______________________________________________________________

Segmento

nombre string: El nombre del rol

______________________________________________________________

Cuerpo de la solicitud

Una matriz de entidades PermisoPermission

______________________________________________________________

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:

nombre se establece en Creadores

POST /2022/06/REST/Roles/Creators/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: 292

Este es el cuerpo de la solicitud de ejemplo:

{
  "entityId": null,
  "operationUID": "b41ac545-d505-7014-edde-51bc4c0d21a0",
  "principal": {
    "name": "Creators",
    "isCustom": false,
    "type": "Role",
    "id": 12345
  },
  "isFixed": false,
  "isInherited": false,
  "isAllowed": false,
  "creationDate": "0001-01-01T00:00:00"
}

______________________________________________________________

Respuesta exitosa

204: Los permisos se agregaron correctamente al rol especificado

Respuesta de error

400: La solicitud o el cuerpo de la solicitud tiene un formato incorrecto y, por lo tanto, es inválido, o se rechaza 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)

415: El servidor no puede aceptar la representación de datos que envió (como se especifica en el encabezado "Content-Type")

5XX: Cualquier código 500 es un error interno del servidor

DELETE /{name}/Permissions/

Elimina permisos para el rol especificado en una red

Token de Scope requerido

bsn.api.main.roles.delete

______________________________________________________________

Segmento

nombre string: El nombre del rol

______________________________________________________________

Cuerpo de la solicitud

Una matriz de entidades de PermisoPermission

______________________________________________________________

Ejemplo de solicitud

Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:

nombre se establece en Creadores

DELETE /2022/06/REST/Roles/Creators/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: 359

Este es el cuerpo de la solicitud de ejemplo:

{
  "entityId": null,
  "operationUID": "b41ac545-d505-7014-edde-51bc4c0d21a0",
  "principal": {
    "name": "Creators",
    "isCustom": false,
    "type": "Role",
    "id": 12345
  },
  "isFixed": false,
  "isInherited": false,
  "isAllowed": false,
  "creationDate": "0001-01-01T00:00:00"
}

______________________________________________________________

Respuesta correcta

204: Los permisos especificados se han eliminado del rol

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 usted solicitó (según se especifica en el encabezado "Accept")

5XX: Cualquier código 500 es un error interno del servidor