Gestión de identidades SmartSense con SCIM v2
Para facilitar la gestión de los usuarios de SmartSense, SmartSense proporciona un conjunto de puntos finales que se ajustan al estándar SCIM versión 2.
Paginación de resultados
Según SCIM RFC 7644, cualquier punto final que devuelva una lista de datos está sujeto a paginación. La información de paginación se incluye en todas las respuestas paginadas de la siguiente manera.
Nombre | Tipo | Descripción |
totalResultados | Número total de resultados que coinciden con la consulta del cliente. | |
startIndex | El índice basado en 1 del primer resultado de la página actual. | |
itemsPerPage | El número de resultados devueltos en la página actual. |
Tipos específicos del SCIM
Los objetos SCIM y sus atributos están definidos por SCIM RFC 7643. A continuación se describen los tipos SCIM utilizados en la implementación SCIM de SmartSense y cómo se utilizan.
Meta
Todos los objetos SCIM contienen un objeto meta. Este objeto no es necesario para PUTs, POSTs, o PATCHes, pero siempre será devuelto con GETs.
Nombre | Tipo | Mutabilidad | Descripción |
resourceType | cadena | Sólo lectura | El nombre del tipo del recurso contenedor. |
ubicación | cadena | Sólo lectura | Una URL que puede utilizarse para OBTENER el objeto. |
SmartSenseEnterpriseUser
SmartSenseEnterpriseUser (now deprecated and no longer required, but remains current for backward compatibility) is an extension of the basic SCIM Enterprise User schema. SmartSenseEnterpriseUser consists of two attributes.
Nombre | Tipo | Mutabilidad | Descripción |
defaultContactRoleId | cadena | LecturaEscritura | Un ContactRoleId que se utilizará al asignar el usuario a un grupo. |
Nombre
Nombre | Tipo | Mutabilidad | Descripción |
givenName | cadena | LecturaEscritura | Nombre del usuario. |
familyName | cadena | LecturaEscritura | Apellido del usuario. |
Correo electrónico
Nombre | Tipo | Mutabilidad | Descripción |
valor | cadena | LecturaEscritura | Dirección de correo electrónico del usuario. |
tipo | cadena | LecturaEscritura | El tipo de dirección de correo electrónico. Siempre debe ser "trabajo". |
principal | booleano | LecturaEscritura | Un booleano que indica si este correo electrónico es el correo electrónico principal del usuario. Siempre debe ser "true". |
Número de teléfono
Los Usuarios de SmartSense pueden configurarse con dos números de teléfono: uno para llamadas de voz y otro para SMS. Un número de teléfono para SMS debe tener su "tipo" configurado en "SMS". Un número de teléfono para llamadas de voz debe tener su "tipo" configurado en "voz".
Nombre | Tipo | Mutabilidad | Descripción |
valor | cadena | LecturaEscritura | The User's phone number. 1 |
tipo | cadena | LecturaEscritura | El tipo de dirección del número de teléfono. Debe ser "SMS" o "voz". |
principal | booleano | LecturaEscritura | Un booleano que indica si este número de teléfono es el número de teléfono principal del usuario. Siempre debe ser "true". |
Note: Accepted Phone Number Formats:
- E.164: `+11234567890`
- RFC3966: `tel:+11234567890` or `tel:+1-123-456-7890`
- *International Format: `+1(123)456-7890,` `+1-123-456-7890,` `+1.123.456.7890,` or`1 123 456 7890`
- National Format:`123-456-7890,` `123.456.7890,` `(123)456-7890,` or `123 456 7890
*If an international number follows the same format as a national number, it will be saved as a US number prefixed with `+1`
Regardless of the input format, SmartSense stores all phone numbers in E.164 format and returns them as `+11234567890.`
Invalid phone number formats will not be saved.
Función de contacto
Los puntos finales de Roles de Contacto se utilizan para crear y actualizar Roles de Contacto desde el sistema SmartSense. Los Roles de Contacto definen la relación que el Usuario tiene con un Grupo. Cuando se asigna un Usuario a un Grupo, también se le debe asignar un Rol de Contacto. Estos Roles de Contacto se utilizan para determinar quién debe ser notificado cuando un Activo entra en estado de alarma.
Se puede asignar un único Rol de Contacto a un Usuario para todos los Grupos a los que esté asignado estableciendo el campo DefaultContactRoleId en el objeto SmartSenseEnterpriseUser.
ContactRoleObjectModel
Nombre | Tipo | Mutabilidad | Descripción |
id | cadena | Sólo lectura | Identificador único global del ContactRole. |
nombre | cadena | Inmutable | El nombre del ContactRole que se muestra en la aplicación SmartSense. |
Tipo de grupo Atributo
Create and Retrieve the Group Type Attributes configured for your Account. Groups in SmartSense can have Attributes defined for them. Different GroupTypes will have different required and non-required attributes depending on their assigned GroupTemplate. These Attributes are used for organization in the SmartSense application.
GroupTypeAttribute Object Model
Nombre | Tipo | Mutabilidad | Descripción |
attributeID | cadena | Sólo lectura | Un identificador único para el atributo. |
attributeName | cadena | Sólo lectura | El nombre del Atributo que se muestra en la aplicación SmartSense. |
attributeType | cadena | Sólo lectura | Nombre del tipo de datos del atributo. |
isRequired | booleano | Sólo lectura | Un booleano que indica si los Grupos de este tipo deben proporcionar un valor para este Atributo. |
groupType | cadena | Sólo lectura | Tipo de grupo al que pertenece el atributo. |
Grupos
Los puntos finales de Grupos se utilizan para crear, actualizar y eliminar Grupos del sistema SmartSense, así como para gestionar los Usuarios asociados a ellos. Los Grupos en SmartSense están organizados en un árbol jerárquico por su Tipo de Grupo. Los Grupos se utilizan para organizar los Activos, y los Usuarios se asignan a los Grupos con un ContactRole. El esquema de Grupos SCIM está definido en el RFC 7643 Sección 4.2.
Modelo de objetos de grupo
SmartSense utiliza todos los atributos del modelo SCIM Group y lo amplía.
Nombre | Tipo | Mutabilidad | Descripción |
id | cadena | Sólo lectura | Un identificador único global para el grupo. |
externalid | cadena | LecturaEscritura | Un identificador proporcionado por el cliente. Este atributo no es utilizado por la aplicación SmartSense y es sólo para seguimiento externo. |
parentid | cadena | Inmutable | El Id del Grupo matriz del Grupo. |
displayName | cadena | LecturaEscritura | Un nombre para el Grupo tal y como se muestra en la aplicación SmartSense. |
tipo | Inmutable | El tipo de Grupo. | |
atributos | matriz | LecturaEscritura | Lista de atributos asociados al Grupo. |
miembros | matriz | LecturaEscritura | Una lista de Usuarios que pertenecen al Grupo. Véase Miembros. |
meta | Sólo lectura | La metainformación del Grupo. |
Miembros Modelo de objetos
Nombre | Tipo | Mutabilidad | Descripción |
válvula | cadena | Inmutable | Id. del usuario. Debe ser un UserId válido. |
contactRoleId | cadena | Inmutable | ContactRoleId del miembro del grupo. |
tipo | cadena | Inmutable | Tipo del objeto miembro. |
$ref | cadena | Inmutable | Una referencia URL que puede utilizarse para OBTENER el miembro. |
Tipo de recurso
Obtenga los Tipos de Recursos SCIM para los recursos definidos de SmartSense. Los Tipos de Recursos SCIM están definidos y son requeridos por el RFC 7643 Sección 6.
Modelo de objeto ResourceType
Nombre | Tipo | Mutabilidad | Descripción |
id | cadena | Sólo lectura | Un ID para el ResourceType. |
nombre | cadena | Sólo lectura | El nombre del Recurso. |
descripción | cadena | Sólo lectura | Descripción del recurso. |
punto final | cadena | Sólo lectura | El punto final principal para recuperar recursos de este ResourceType. |
esquema | cadena | Sólo lectura | El esquema base de ResourceTypes. |
schemaExtension | Sólo lectura | Una lista de esquemas que amplían el esquema base para el ResourceType. | |
meta | Sólo lectura | La metainformación para el ResourceType. |
Modelo de objetos SchemaExtension
Nombre | Tipo | Mutabilidad | Descripción |
esquema | cadena | Sólo lectura | La extensión del esquema que se está aplicando. |
obligatorio | booleano | Sólo lectura | Si es necesario aplicar la extensión al interactuar con el sistema. |
Usuarios
Los puntos finales Usuarios se utilizan para crear, actualizar y eliminar Usuarios del sistema SmartSense. Los Usuarios de SmartSense creados a través de la API SCIM sólo pueden iniciar sesión en el sistema SmartSense a través de una integración SAML SSO. SmartSense sólo utiliza un subconjunto de los atributos de Usuario SCIM disponibles. El esquema completo de SCIM User se define en RFC 7643 Sección 4.1.
Modelo de objetos de usuario
Nombre | Tipo | Mutabilidad | Descripción |
id | cadena | Sólo lectura | Identificador único global del Usuario. |
externalid | cadena | LecturaEscritura | Un identificador proporcionado por el cliente. Este atributo no es utilizado por la aplicación SmartSense y es sólo para seguimiento externo. |
nombre de usuario | cadena | Inmutable | Un identificador de cadena único del usuario. |
activo | booleano | LecturaEscritura | Un booleano que marca si el usuario tiene permiso para acceder al sistema. |
userType | AccessRole | LecturaEscritura | Cadena que identifica los permisos del usuario en el sistema. |
nombre | LecturaEscritura | Objeto complejo que contiene el nombre y los apellidos del usuario. | |
correos electrónicos | matriz | LecturaEscritura | Una lista de correos electrónicos. SmartSense sólo acepta y devuelve un correo electrónico en esta lista. |
números de teléfono | matriz | LecturaEscritura | Una lista de PhoneNumbers. SmartSense acepta dos tipos de números de teléfono: SMS y voz. |
grupos | matriz | Sólo lectura | Una lista de los Grupos a los que pertenece el Usuario. |
meta | Sólo lectura | La meta info del Usuario. |
Interactive API Documentation
For detailed endpoint documentation and the ability to test API calls directly, visit our Swagger documentation:
The Swagger interface provides:
Request and response schemas
Interactive API testing