Referência da API do usuário SCIM¶

Cabeçalhos HTTP¶

A Snowflake SCIM API usa tokens de portador para autenticação HTTP.

Cada solicitação HTTP à Snowflake SCIM API permite os seguintes cabeçalhos HTTP:

Atributos do usuário¶

Você pode especificar os atributos do usuário no corpo das solicitações de API como pares chave-valor no formato JSON. Esses pares têm informações sobre o usuário, como seu nome de exibição ou endereço de e-mail. Os provedores de identidade podem especificar seus próprios nomes de chaves para cada atributo. Por exemplo, os provedores de identidade podem usar a chave lastName, em vez de familyName, para representar o sobrenome do usuário. O Snowflake não oferece suporte a atributos do usuário com múltiplos valores.

O Snowflake oferece suporte aos seguintes atributos para o gerenciamento do ciclo de vida do usuário:

Atributos personalizados¶

Você pode definir atributos personalizados que não são definidos pelo RFC 7643, como defaultRole.

Você pode usar os seguintes namespaces para definir atributos personalizados ao fazer solicitações POST, PUT e PATCH:

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

Esse namespace fazia parte do original implementação SCIM no Snowflake. Você só pode usar esse namespace para definir atributos personalizados nas integração de segurança Okta SCIM.

Você não pode usar esse namespace para definir os atributos personalizados nas integrações de segurança do Microsoft Azure SCIM ou integrações de SCIM personalizadas.

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

Você pode usar esse namespace para definir atributos personalizados para todas as interações de SCIM. Você deve usar este namespace para definir atributos personalizados nas integrações de segurança do Microsoft Azure SCIM ou integrações de segurança de SCIM personalizadas.

O Snowflake oferece suporte aos seguintes atributos personalizados:

Verificação de existência de um usuário¶

Método e ponto de extremidade:

GET /scim/v2/Users?filter=userName eq "{{user_name}}"

Descrição:

Retorna detalhes sobre um usuário associado ao parâmetro de consulta userName.

Retorna o código de status de resposta HTTP 200, se a solicitação HTTP tiver sido concluída com sucesso.

Como obter detalhes sobre um usuário¶

Método e ponto de extremidade:

GET /scim/v2/Users/{{user_id}}

Descrição:

Retorna detalhes sobre um usuário associado ao parâmetro de caminho user_id.

Retorna o código de status de resposta HTTP 200, se a solicitação HTTP tiver sido concluída com sucesso.

Crie um usuário¶

Método e ponto de extremidade:

POST /scim/v2/Users

Descrição:

Cria um usuário no Snowflake.

Retorna o código de status de resposta HTTP 201, se a solicitação HTTP tiver sido concluída com sucesso.

Se o usuário já existe ou a solicitação HTTP falha por um motivo diferente, então o Snowflake retorna o código de status de resposta HTTP 409.

Exemplos:

Crie um usuário com userName e loginName mapeados para o mesmo valor:

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:2.0:User"
  ],
  "userName": "test_user_1",
  "password": "test",
  "name": {
    "givenName": "test",
    "familyName": "user"
  },
  "emails": [
    {"value": "test.user@snowflake.com"}
  ],
  "displayName": "test user",
  "active": true
}

Copy

Crie um usuário com userName e loginName mapeados para valores diferentes:

Nota

Se você usa o Okta como seu provedor de identidade, siga este procedimento.

{
  "active": true,
  "displayName": "test user",
  "emails": [
    {"value": "test.user@snowflake.com"}
  ],
  "name": {
    "familyName": "test_last_name",
    "givenName": "test_first_name"
  },
  "password": "test_password",
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "snowflakeUserName": "USER5"
  },
  "userName": "USER5"
}

Copy

Substituição de atributos do usuário¶

Método e ponto de extremidade:

PATCH /scim/v2/Users/{{id}}

Descrição:

Substitui atributos do usuário associados ao parâmetro de caminho id.

Você deve definir op como replace para executar essa solicitação HTTP.

active permite os seguintes valores:

• false: desativa o usuário.

• true: ativa o usuário.

Retorna o código de status de resposta HTTP 200 se a solicitação HTTP tiver sido concluída com sucesso.

Se não for bem-sucedido, o código de resposta HTTP 204 será retornado.

Exemplos:

Desativar um usuário e atualiza seu givenName para deactivated_user:

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

Copy

Atualize um usuário com userName e loginName mapeados para o mesmo valor:

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

Copy

Atualize um usuário com userName e loginName mapeados para valores diferentes.

Se o Okta for seu provedor de identidade, siga este procedimento.

{
  "Operations": [
    {
      "op": "replace",
      "path": "userName",
      "value": "test_updated_name"
    },
    {
      "op": "replace",
      "path": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.snowflakeUserName",
      "value": "USER5"
    }
  ],
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]
}

Copy

Atualização de um usuário¶

Método e ponto de extremidade:

PUT /scim/v2/Users/{{id}}

Descrição:

Atualiza os atributos do usuário associado ao parâmetro de caminho id.

Se não for bem-sucedido, o código de resposta HTTP 400 será retornado. A solicitação HTTP não será bem-sucedida se a solicitação tentar alterar atributos imutáveis ou se os atributos que estiverem sendo alterados não existirem no Snowflake.

Exemplos:

Atualize um usuário e seus atributos "defaultRole", "defaultSecondaryRoles" e "defaultWarehouse".

Para especificar os atributos "defaultRole", "defaultSecondaryRoles" e "defaultWarehouse", você deve usar um dos esquemas extension <label-scim_intro_user_attributes>. O atributo defaultSecondaryRoles só aceita "ALL" como um valor.

Nota

O método PUT é mais caro que o método PATCH. Use a operação PATCH em seu lugar.

{
  "schemas": [
   "urn:ietf:params:scim:schemas:core:2.0:User",
   "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ],
  "userName": "test_user_1",
  "password": "test",
  "name": {
    "givenName": "test",
    "familyName": "user"
  },
  "emails": [{
    "primary": true,
    "value": "test.user@snowflake.com",
    "type": "work"
  }
  ],
  "displayName": "test user",
  "active": true,
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "defaultRole" : "test_role",
    "defaultSecondaryRoles" : "ALL",
    "defaultWarehouse" : "test_warehouse"
  }
}

Copy

Exclusão de um usuário¶

Método e ponto de extremidade:

DELETE /scim/v2/Users/{{id}}

Descrição:

Exclui o usuário associado ao parâmetro de caminho id.