Gestión automatizada de usuarios: API SCIM

Para configurar el aprovisionamiento y la administración de su usuario de New Relic desde un proveedor de identidad, proporcionamos una API SCIM para los proveedores de identidad que aún no tienen aplicaciones e implementaciones específicas de New Relic.

¿Quién debería utilizar la API SCIM?

Si tiene un proveedor de identidad que tiene una aplicación New Relic (Azure AD, Okta y OneLogin), consulte las guías correspondientes. La API SCIM está destinada a organizaciones que no utilizan esos proveedores de identidad o que desean utilizar la API SCIM para una configuración adicional que no está disponible con las aplicaciones (por ejemplo, managing user type). Restricciones adicionales:

PingOne de Ping Identity no es compatible porque no permite el aprovisionamiento de grupos.

Antes de utilizar nuestra API SCIM, primero debe configurar un dominio de autenticación con SCIM habilitado. La UI de usuario del dominio de autenticación le proporcionará valores que puede utilizar para integrarse con su proveedor de identidad.

Tenga en cuenta que después de configurar una integración con la API SCIM, hay siguientes pasos a seguir, incluida la degradación de algunos usuarios a usuarios básicos y la concesión de acceso a grupos a cuentas de New Relic.

Nuestro tutorial de API SCIM

Este documento contiene información técnica sobre nuestra API SCIM. Para obtener instrucciones detalladas sobre su uso, consulte el tutorial de API SCIM.

SCIM proveedor de servicios

Nuestro proveedor de servicios SCIM sigue la API SCIM 2.0 como se describe en los RFC 7643 y 7644. No es necesario implementar todos los aspectos de la especificación SCIM 2.0 para integrar su información de usuario con New Relic. De hecho, el propio proveedor de servicios de New Relic no implementa todos los aspectos de la especificación. Este documento describe las características de la especificación disponibles para una integración con New Relic.

Autenticación

La autenticación requiere un token de portador. Este token de portador es específico de su dominio de autenticación New Relic y se muestra cuando habilita SCIM por primera vez para un dominio de autenticación.

Recursos soportados

El proveedor de servicios New Relic admite los siguientes recursos SCIM: Group , User , Service provider config , Resource type y Schema. Bulk y Search no son compatibles. Para obtener más información sobre cómo el RFC describe el extremo del recurso, consulte la especificación del protocolo SCIM RFC 7644.

Esquemas

New Relic utiliza un subconjunto de los campos disponibles en el esquema central SCIM. Otros campos SCIM se ignoran si se incluyen en solicitudes entrantes. Los campos utilizados por New Relic son:

Group:

Nombre del campo SCIM	Descripción
`displayName`	Required. Nombre del grupo.
`members`	Lista de usuarios en el grupo.

User:

Nombre del campo SCIM	Descripción
`externalId`	Identificador único del usuario utilizado por su sistema.
`userName`	Required. Identificador único para el usuario dentro del sistema de New Relic. Utilice la dirección de correo electrónico del usuario.
`name.familyName`	Apellido del usuario.
`name.givenName`	Nombre del usuario.
`emails` o `emails.value`	Required. Dirección de correo electrónico del usuario.
`timezone`	Zona horaria del usuario en el formato de base de datos de zona horaria de la IANA, también conocido como formato de base de datos de zona horaria "Olson" (por ejemplo, "América/Los_Angeles").
`active`	Required. Booleano que indica si el usuario debe estar activo o inactivo dentro de New Relic.
`groups`	Listado de grupos a los que pertenece el usuario.

Esquema de tipo de usuario de New Relic (básico, central o completo)

Esta es una extensión de esquema opcional para el atributo de usuario específico de New Relic. Actualmente, esto proporciona control solo sobre el tipo de usuario de un usuario. Para obtener un tutorial que muestra cómo utilizar esto, consulte el tutorial de API SCIM.

urn:ietf:params:scim:schemas:extension:newrelic:2.0:User:

Nombre del campo SCIM	Descripción
`nrUserType`	El tipo de usuario: `full user`, `core user` o `basic user`.

Acciones apoyadas

SCIM proporciona varias opciones para manipular grupos y usuarios. El proveedor de servicios New Relic admite las siguientes opciones.

Al configurar, tenga en cuenta que:

Sólo se admite el filtrado simple. El operador eq se puede utilizar con una expresión de filtro básica. Por ejemplo, “displayName eq "Example Group 1”. Otros operadores no son compatibles.
PUT las actualizaciones no requieren que se incluyan todos los campos. Los campos que no estén incluidos no se cambiarán. Al hacer un PUT, si un campo obligatorio ya tiene el valor apropiado, no es necesario incluir el campo.

Las acciones admitidas son:

Solicitud de ejemplo:

POST /Groups

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "displayName": "Example Group 1",
  "members": []
}

Respuesta de ejemplo:

201 Created

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "d0652232-b14f-434d-9c6f-36de7e1ab010",
  "displayName": "Example Group 1",
  "meta": {
    "resourceType": "Group",
    "created": "2019-11-08T21:33:13.055Z",
    "lastModified": "2019-11-08T21:33:13.055Z"
  },
  "members": []
}

Solicitud de ejemplo:

GET /Groups/YOUR_GROUP_ID

Respuesta de ejemplo:

200 OK

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "d0652232-b14f-434d-9c6f-36de7e1ab010",
  "displayName": "Example Group 1",
  "meta": {
    "resourceType": "Group",
    "created": "2019-11-08T21:33:13.055Z",
    "lastModified": "2019-11-08T21:33:13.055Z"
  },
  "members": []
}

Solicitud de ejemplo:

GET /Groups?filter=displayName eq "Example Group 1"

Respuesta de ejemplo:

200 OK

{
  "totalResults": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [{
    "schemas": [
      "urn:ietf:params:scim:schemas:core:2.0:Group"
    ],
    "id": "d0652232-b14f-434d-9c6f-36de7e1ab010",
    "displayName": "Example Group 1",
    "meta": {
      "resourceType": "Group",
      "created": "2019-11-08T21:33:13.055Z",
      "lastModified": "2019-11-08T21:33:13.055Z"
    },
    "members": []
  }]
}

En la solicitud, incluya los campos que desea cambiar. Si incluye el campo members , el usuario del grupo se ajustará para que coincida con el contenido del campo de miembros. Solicitud de ejemplo:

PUT /Groups/YOUR_GROUP_ID

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "displayName": "Example Group 1a"
}

Respuesta de ejemplo:

200 OK

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "d0652232-b14f-434d-9c6f-36de7e1ab010",
  "displayName": "Example Group 1a",
  "meta": {
    "resourceType": "Group",
    "created": "2019-11-08T21:33:13.055Z",
    "lastModified": "2019-11-08T22:47:14.019Z"
  },
  "members": []
}

Solicitud de ejemplo:

PATCH /Groups/YOUR_GROUP_ID

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [{
    "op": "Replace",
    "path": "displayName",
    "value": "Example Group 1b"
  }]
}

Respuesta de ejemplo:

204 No Content

Solicitud de ejemplo:

PATCH /Groups/YOUR_GROUP_ID

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [{
    "op": "Add",
    "path": "members",
    "value": [{
      "value": "f0cbc276-16c9-4d1a-abc0-1856b0c74224"
    }]
  }]
}

Respuesta de ejemplo:

204 No Content

Solicitud de ejemplo:

PATCH /Groups/YOUR_GROUP_ID

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [{
    "op": "Remove",
    "path": "members",
    "value": [{
      "value": "f0cbc276-16c9-4d1a-abc0-1856b0c74224"
    }]
  }]
}

Respuesta de ejemplo:

204 No Content

Solicitud de ejemplo:

POST /Users

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "externalId": "external-id-1",
  "userName": "example-user-1@example.com",
  "name": {
    "familyName": "User 1",
    "givenName": "Example"
  },
  "emails": [{
    "value": "example-user-1@example.com",
    "primary": true
  }],
  "timezone": "America/Los_Angeles",
  "active": true,
  "groups": []
}

Respuesta de ejemplo:

201 Created

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "f0cbc276-16c9-4d1a-abc0-1856b0c74224",
  "externalId": "external-id-1",
  "userName": "example-user-1@example.com",
  "name": {
    "familyName": "User 1",
    "givenName": "Example"
  },
  "emails": [{
    "value": "example-user-1@example.com",
    "primary": true
  }],
  "timezone": "America/Los_Angeles",
  "active": true,
  "meta": {
    "resourceType": "User",
    "created": "2019-11-08T22:07:12.477Z",
    "lastModified": "2019-11-08T22:07:12.477Z"
  },
  "groups": []
}

Solicitud de ejemplo:

GET /Users/YOUR_USER_ID

Respuesta de ejemplo:

200 OK

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "f0cbc276-16c9-4d1a-abc0-1856b0c74224",
  "externalId": "external-id-1",
  "userName": "example-user-1@example.com",
  "name": {
    "familyName": "User 1",
    "givenName": "Example"
  },
  "emails": [{
    "value": "example-user-1@example.com",
    "primary": true
  }],
  "timezone": "America/Los_Angeles",
  "active": true,
  "meta": {
    "resourceType": "User",
    "created": "2019-11-08T22:07:12.477Z",
    "lastModified": "2019-11-08T22:07:12.477Z"
  },
  "groups": []
}

Solicitud de ejemplo:

GET /Users?filter=externalId eq "external-id-1"

Respuesta de ejemplo:

200 OK

{
  "totalResults": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [{
    "schemas": [
      "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "id": "f0cbc276-16c9-4d1a-abc0-1856b0c74224",
    "externalId": "external-id-1",
    "userName": "example-user-1@example.com",
    "name": {
      "familyName": "User 1",
      "givenName": "Example"
    },
    "emails": [{
      "value": "example-user-1@example.com",
      "primary": true
    }],
    "timezone": "America/Los_Angeles",
    "active": true,
    "meta": {
      "resourceType": "User",
      "created": "2019-11-08T22:07:12.477Z",
      "lastModified": "2019-11-08T22:07:12.477Z"
    },
    "groups": []
  }]
}

En la solicitud, incluya los campos que desea cambiar. Si incluye el campo groups , los grupos del usuario se ajustarán para que coincidan con el contenido del campo de grupos. Solicitud de ejemplo:

PUT /Users/YOUR_USER_ID

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "name": {
    "familyName": "User 1A",
    "givenName": "Example"
  }
}

Respuesta de ejemplo:

200 OK

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "f0cbc276-16c9-4d1a-abc0-1856b0c74224",
  "externalId": "external-id-1",
  "userName": "example-user-1@example.com",
  "name": {
    "familyName": "User 1A",
    "givenName": "Example"
  },
  "emails": [{
    "value": "example-user-1@example.com",
    "primary": true
  }],
  "timezone": "America/Los_Angeles",
  "active": true,
  "meta": {
    "resourceType": "User",
    "created": "2019-11-08T22:07:12.477Z",
    "lastModified": "2019-11-08T22:28:33.552Z"
  },
  "groups": []
}

Solicitud de ejemplo:

PATCH /Users/YOUR_USER_ID

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [{
    "op": "Replace",
    "path": "active",
    "value": "false"
  }]
}

Respuesta de ejemplo:

204 No Content

Desviación del RFC

Esta sección describe áreas donde el proveedor de servicios SCIM de New Relic se desvía del protocolo SCIM RFC 7644. Los números de sección se refieren a los números de sección del RFC.

Los elementos de esta sección podrían cambiar a medida que trabajamos para que nuestro proveedor de servicios cumpla plenamente con el RFC.

Nombre de la sección RFC	Número de sección RFC	Descripción de la desviación
Creando recursos	3.3.	El campo `meta.location` no está configurado.
Filtración	3.4.2.2.	El único operador admitido actualmente es `eq`. Los nombres de los campos distinguen entre mayúsculas y minúsculas. Los atributos de cadena se comparan distinguiendo entre mayúsculas y minúsculas. No se admite anteponer el esquema al nombre del campo. Por ejemplo, `filter=urn:ietf:params:scim:schemas:core:2.0:User:userName eq "johnsmith"` no funcionará.
`/Me` Alias de sujeto autenticado	3.11.	`GET` Con el recurso `/Me` devuelve un `404 Not Found`.
Configuración del proveedor de servicios extremo	4.	El proveedor de servicios característica descubrimiento extremo no admite filtrado.
Consideraciones sobre token de portador y cookies	7.4.	Los tokens al portador no tienen una fecha de vencimiento establecida.

Próximos pasos cuando haya terminado

Próximos pasos:

Ajusta el tipo de usuario de tus usuarios

Cuando sus usuarios estén aprovisionados en New Relic, podrá verlos en la UIUser management .

Si agrega un usuario a New Relic a través de SCIM pero no administra su tipo de usuario a través de SCIM, comienza como usuario básico. Para actualizar usuario, tienes dos opciones:

Utilice la UIde usuario de administración de usuarios.
Utilice la API SCIM para administrar el tipo de usuario.

Asignar acceso de grupo

Una vez que su usuario esté en New Relic, debe otorgarle acceso a cuentas, grupos específicos y roles específicos de New Relic. Sin hacer esto, su usuario no tendrá acceso a las cuentas de New Relic. Para aprender cómo hacer esto, consulte:

Configurar SSO de SAML

Si desea configurar SAML SSO, lo que hacen la mayoría de los usuarios de SCIM, consulte los documentos de SAML SSO.

Te ofrecemos esta traducción automática para facilitar la lectura.

Gestión automatizada de usuarios: API SCIM

¿Quién debería utilizar la API SCIM?

Nuestro tutorial de API SCIM

SCIM proveedor de servicios

Autenticación

Recursos soportados

Esquemas

Esquema de tipo de usuario de New Relic (básico, central o completo)

Acciones apoyadas

Crea un grupo

Obtener grupo

Obtener grupo por consulta

Actualizar grupo con PUT

Actualizar grupo con PATCH (Campos de no miembros)

Actualizar grupo con PATCH (Agregar miembros)

Actualizar grupo con PATCH (Eliminar miembros)

Eliminar grupo

Crear usuario

Obtener usuario

Obtener usuario por consulta

Actualizar usuario con PUT

Actualizar usuario con PATCH

Borrar usuario

Desviación del RFC

Próximos pasos cuando haya terminado

Ajusta el tipo de usuario de tus usuarios

Asignar acceso de grupo

Configurar SSO de SAML

Te ofrecemos esta traducción automática para facilitar la lectura.

Gestión automatizada de usuarios: API SCIM

¿Quién debería utilizar la API SCIM? .css-21sua1{background:none;border:none;width:0;padding:0;}

Nuestro tutorial de API SCIM

SCIM proveedor de servicios

Autenticación

Recursos soportados

Esquemas

Esquema de tipo de usuario de New Relic (básico, central o completo)

Acciones apoyadas

Obtener grupo

Obtener grupo por consulta

Actualizar grupo con PUT

Actualizar grupo con PATCH (Campos de no miembros)

Actualizar grupo con PATCH (Agregar miembros)

Actualizar grupo con PATCH (Eliminar miembros)

Eliminar grupo

Crear usuario

Obtener usuario

Obtener usuario por consulta

Actualizar usuario con PUT

Actualizar usuario con PATCH

Borrar usuario

Desviación del RFC

Próximos pasos cuando haya terminado

Ajusta el tipo de usuario de tus usuarios

Asignar acceso de grupo

Configurar SSO de SAML

¿Quién debería utilizar la API SCIM?