Gerenciamento automatizado de usuários: API SCIM

Para configurar o provisionamento e o gerenciamento do seu usuário New Relic a partir de um provedor de identidade, fornecemos uma API SCIM para os provedores de identidade que ainda não possuem aplicativos e implementações específicos do New Relic.

Quem deve usar a API SCIM?

Se você tiver um provedor de identidade que tenha um aplicativo New Relic (Azure AD, Okta e OneLogin), consulte os guias desses aplicativos. A API SCIM destina-se a organizações que não usam esses provedores de identidade ou que desejam usar a API SCIM para configuração adicional não disponível com os aplicativos (por exemplo, managing user type). Restrições adicionais:

O PingOne do Ping Identity não é compatível porque não permite o provisionamento de grupos.

Antes de usar nossa API SCIM, você deve primeiro configurar um domínio de autenticação com SCIM habilitado. A interface do domínio de autenticação fornecerá valores que você pode usar para integração com seu provedor de identidade.

Observe que depois de configurar uma integração com a API SCIM, há as próximas etapas a serem executadas, incluindo o downgrade de algum usuário para usuário básico e a concessão de acesso a grupos de usuários às contas New Relic.

Nosso tutorial da API SCIM

Este documento contém informações técnicas sobre nossa API SCIM. Para obter instruções detalhadas sobre como usá-lo, consulte o tutorial da API SCIM.

SCIM provedor de serviço

Nosso provedor de serviço SCIM segue a API SCIM 2.0 conforme descrito nas RFCs 7643 e 7644. Você não precisa implementar todos os aspectos da especificação SCIM 2.0 para integrar suas informações de usuário ao New Relic. Na verdade, o próprio provedor de serviço New Relic não implementa todos os aspectos da especificação. Este documento descreve o recurso da especificação disponível para integração com New Relic.

Autenticação

A autenticação requer um token de portador. Esse token de portador é específico para seu domínio de autenticação New Relic e é exibido quando o SCIM é ativado pela primeira vez para um domínio de autenticação.

Recursos suportados

O provedor de serviço New Relic suporta os seguintes recursos SCIM: Group , User , Service provider config , Resource type e Schema. Bulk e Search não são suportados. Para obter mais informações sobre como a RFC descreve o ponto final do recurso, consulte Especificação do protocolo RFC 7644 SCIM.

Esquemas

A New Relic usa um subconjunto de campos disponíveis no esquema principal do SCIM. Outros campos SCIM serão ignorados se forem incluídos nas solicitações recebidas. Os campos usados pela New Relic são:

Group:

Nome do campo SCIM	Descrição
`displayName`	Required. Nome do grupo.
`members`	Lista de usuários do grupo.

User:

Nome do campo SCIM	Descrição
`externalId`	Identificador exclusivo do usuário utilizado pelo seu sistema.
`userName`	Required. Identificador exclusivo para o usuário no sistema da New Relic. Use o endereço de e-mail do usuário.
`name.familyName`	Sobrenome do usuário.
`name.givenName`	Primeiro nome do usuário.
`emails` ou `emails.value`	Required. Endereço de e-mail do usuário.
`timezone`	Fuso horário do usuário no formato de banco de dados de fuso horário da IANA, também conhecido como formato de banco de dados de fuso horário "Olson" (por exemplo, "América/Los_Angeles").
`active`	Required. Booleano que indica se o usuário deve ou não estar ativo ou inativo no New Relic.
`groups`	Lista de grupos aos quais o usuário pertence.

New Relic (básico, principal ou completo)

Esta é uma extensão de esquema opcional para atributo de usuário específico do New Relic. Atualmente, isso fornece controle apenas sobre o tipo de usuário de um usuário. Para obter um tutorial mostrando como usar isso, consulte o tutorial da API SCIM.

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

Nome do campo SCIM	Descrição
`nrUserType`	O tipo de usuário: `full user`, `core user` ou `basic user`.

Ações apoiadas

O SCIM oferece diversas opções para manipulação de grupos e usuários. O provedor de serviço New Relic oferece suporte às seguintes opções.

Ao configurar, esteja ciente de que:

Apenas a filtragem simples é suportada. O operador eq pode ser usado com uma expressão de filtro básica. Por exemplo, “displayName eq "Example Group 1”. Outros operadores não são suportados.
PUT as atualizações não exigem que todos os campos sejam incluídos. Os campos que não estiverem incluídos não serão alterados. Ao fazer um PUT, se um campo obrigatório já tiver o valor apropriado, não é necessário incluir o campo.

As ações apoiadas são:

Solicitação de exemplo:

POST /Groups

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

Exemplo de resposta:

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": []
}

Solicitação de exemplo:

GET /Groups/YOUR_GROUP_ID

Exemplo de resposta:

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": []
}

Solicitação de exemplo:

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

Exemplo de resposta:

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": []
  }]
}

Na solicitação, inclua os campos que você deseja alterar. Se você incluir o campo members , o usuário do grupo será ajustado para corresponder ao conteúdo do campo membros. Solicitação de exemplo:

PUT /Groups/YOUR_GROUP_ID

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

Exemplo de resposta:

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": []
}

Solicitação de exemplo:

PATCH /Groups/YOUR_GROUP_ID

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

Exemplo de resposta:

204 No Content

Solicitação de exemplo:

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"
    }]
  }]
}

Exemplo de resposta:

204 No Content

Solicitação de exemplo:

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"
    }]
  }]
}

Exemplo de resposta:

204 No Content

Solicitação de exemplo:

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": []
}

Exemplo de resposta:

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": []
}

Solicitação de exemplo:

GET /Users/YOUR_USER_ID

Exemplo de resposta:

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": []
}

Solicitação de exemplo:

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

Exemplo de resposta:

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": []
  }]
}

Na solicitação, inclua os campos que você deseja alterar. Se você incluir o campo groups , os grupos do usuário serão ajustados para corresponder ao conteúdo do campo grupos. Solicitação de exemplo:

PUT /Users/YOUR_USER_ID

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

Exemplo de resposta:

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": []
}

Solicitação de exemplo:

PATCH /Users/YOUR_USER_ID

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

Exemplo de resposta:

204 No Content

Desvio da RFC

Esta seção descreve áreas onde o provedor de serviço SCIM da New Relic se desvia do protocolo SCIM RFC 7644. Os números das seções referem-se aos números das seções RFC.

Os itens nesta seção podem mudar à medida que trabalhamos para que nosso provedor de serviço esteja em total conformidade com a RFC.

Nome da seção RFC	Número da seção RFC	Descrição do Desvio
Criando Recursos	3.3.	O campo `meta.location` não está definido.
Filtragem	3.4.2.2.	O único operador suportado atualmente é `eq`. Os nomes dos campos diferenciam maiúsculas de minúsculas. String atributo são comparados diferenciando maiúsculas de minúsculas. Não há suporte para prefixar o nome do campo com o esquema. Por exemplo, `filter=urn:ietf:params:scim:schemas:core:2.0:User:userName eq "johnsmith"` não funcionará.
`/Me` Alias de Assunto Autenticado	3.11.	`GET` com o recurso `/Me` retorna um `404 Not Found`.
Endpoint de configuração do provedor de serviço	4.	O endpoint de descoberta do provedor de serviço de recurso não suporta filtragem.
Considerações sobre token de portador e cookies	7.4.	O token ao portador não tem uma data de expiração definida.

Próximas etapas quando terminar

Próximos passos:

Ajuste o tipo de usuário dos seus usuários

Quando seus usuários são provisionados no New Relic, você pode vê-los na interface do usuárioUser management .

Se você estiver adicionando usuário ao New Relic via SCIM, mas não gerenciando seu tipo de usuário via SCIM, eles começarão como usuário básico. Para atualizar o usuário, você tem duas opções:

Utilize a interface de gerenciamento de usuários.
Use a API SCIM para gerenciar o tipo de usuário.

Atribuir acesso ao grupo

Depois que seu usuário estiver no New Relic, você precisará conceder-lhe acesso a contas específicas do New Relic, grupos específicos e funções específicas. Sem fazer isso, seu usuário não terá acesso às contas da New Relic. Para saber como fazer isso, veja:

Configurar SSO SAML

Se você deseja configurar o SSO SAML, o que a maioria dos usuários SCIM faz, consulte a documentação do SSO SAML.

Esta tradução de máquina é fornecida para sua comodidade.

Gerenciamento automatizado de usuários: API SCIM

Quem deve usar a API SCIM?

Nosso tutorial da API SCIM

SCIM provedor de serviço

Autenticação

Recursos suportados

Esquemas

New Relic (básico, principal ou completo)

Ações apoiadas

Criar grupo

Obter grupo

Obter grupo por consulta

Atualizar grupo com PUT

Atualizar grupo com PATCH (campos de não-membro)

Atualizar grupo com PATCH (Adicionar membros)

Atualizar grupo com PATCH (Remover membros)

Excluir grupo

Criar usuário

Obter usuário

Obter usuário por consulta

Atualizar usuário com PUT

Atualizar usuário com PATCH

Deletar usuário

Desvio da RFC

Próximas etapas quando terminar

Ajuste o tipo de usuário dos seus usuários

Atribuir acesso ao grupo

Configurar SSO SAML

Esta tradução de máquina é fornecida para sua comodidade.

Gerenciamento automatizado de usuários: API SCIM

Quem deve usar a API SCIM? .css-21sua1{background:none;border:none;width:0;padding:0;}

Nosso tutorial da API SCIM

SCIM provedor de serviço

Autenticação

Recursos suportados

Esquemas

New Relic (básico, principal ou completo)

Ações apoiadas

Obter grupo

Obter grupo por consulta

Atualizar grupo com PUT

Atualizar grupo com PATCH (campos de não-membro)

Atualizar grupo com PATCH (Adicionar membros)

Atualizar grupo com PATCH (Remover membros)

Excluir grupo

Criar usuário

Obter usuário

Obter usuário por consulta

Atualizar usuário com PUT

Atualizar usuário com PATCH

Deletar usuário

Desvio da RFC

Próximas etapas quando terminar

Ajuste o tipo de usuário dos seus usuários

Atribuir acesso ao grupo

Configurar SSO SAML

Quem deve usar a API SCIM?