Ir para o conteúdo principal
Documentação
Documentação
Adaptive Planning
Última atualização: 2023-06-23
Conjuntos de permissões

Conjuntos de permissões

Ponto de extremidade de URL

https://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/users/permissionSets
Versão: v1
Categoria
Atualização de dados
Descrição
Atribua conjuntos de permissões a usuários do Adaptive Planning.
Permissão obrigatória para invocar
Usuários
com acesso administrativo
,
conjuntos de permissões
A API de atribuição de conjunto de permissões permite que você recupere e atribua conjuntos de permissões a usuários.

VERBs de HTTPS com suporte:

Verbo HTTP
Recurso único
Recurso de cobrança
Descrição
GET
Sem suporte
Com suporte
Recupera todos os usuários e seus conjuntos de permissões atribuídos.
POST
Com suporte
Com suporte
Adiciona um conjunto de permissões ou atualiza um conjunto de permissões existente para um usuário.

GET

Solicitação
/users/permissionSets
Recupera uma coleção de conjuntos de permissões atribuídas a usuários
Recupera todos os usuários e seus conjuntos de permissões atribuídos. Você pode filtrar por instanceCode. Se o parâmetro de consulta instanceCode está ausente, a API recupera todos os usuários e seus conjuntos de permissões na instância por padrão. A paginação usa os valores por padrão para limite ou deslocamento se você não especifica esses parâmetros de consulta.
Exemplo de URI de solicitação:
HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/users/
Parâmetros de consulta:
Nome
Descrição
Obrigatório
instanceCode
O identificador exclusivo de uma instância que define o contexto da instância.
N
limit
O número máximo de objetos em uma única resposta. O valor por padrão é 500. O máximo é 500.
N
offset
O índice de base zero do primeiro usuário em uma coleção de respostas. O valor por padrão é 0.
Use o deslocamento com o parâmetro de limite para controlar a paginação de uma coleção de respostas.
N
Exemplo de resposta
Exemplo de resposta de uma instância sincronizada pelo usuário com o Workday
 


  "links": {
      "next": "https://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?offset=10&limit=5",
      "previous": "https://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?offset=0&limit=5"
  },{
  "total": 34,
  "users": [
      {
    "userGuid": "111SampleUserGuid",
    "wid": "14400000000000000000000000000samplewid",
    "userName": "sampleuser1@company.com",
    "permissionSet": [
      {
        "id": 1,
        "name": "samplePermissionSet1"
      }
    ]
  },
      {
    "userGuid": "112SampleUserGuid",
    "wid": "24400000000000000000000000000samplewid",
    "userName": "sampleuser3@company.com",
    "permissionSet": [
      {
        "id": 1,
        "name": "samplePermissionSet1"
      }
    ]
  },
      {
    "userGuid": "113SampleUserGuid",
    "wid": "34400000000000000000000000000samplewid",
    "userName": "sampleuser3@company.com",
    "permissionSet": [
      {
        "id": 2,
        "name": "samplePermissionSet2"
      }
    ]
  },
      {
    "userGuid": "114SampleUserGuid",
    "wid": "44400000000000000000000000000samplewid",
    "userName": "sampleuser4@company.com",
    "permissionSet": [
      {
        "id": 3,
        "name": "samplePermissionSet3"
      }
    ]
  },
      {
    "userGuid": "115SampleUserGuid",
    "wid": "54400000000000000000000000000samplewid",
    "userName": "sampleuser5@company.com",
    "permissionSet": [
      {
        "id": 4,
        "name": "samplePermissionSet4"
      }
    ]
  }
]
}

PUBLICAR:

Solicitação:
/users/permissionSets:
Atribui ou atualiza conjuntos de permissões para usuários.
Adiciona um conjunto de permissões ou atualiza um conjunto de permissões existente para um usuário. Você pode filtrar por instanceCode. Se o parâmetro de consulta instanceCode está ausente, a API atribui os conjuntos de permissões correspondentes a todos os usuários na instância por padrão. No corpo da solicitação, especifique estes campos de consulta obrigatórios: <userIdentifier> e permissionSet. Para enviar uma solicitação em massa para atribuição de conjuntos de permissões correspondentes a vários usuários, especifique uma matriz que contenha cada atribuição de permissão.
Parâmetros de consulta:
Nome
Descrição
Obrigatório
instanceCode
O identificador exclusivo de uma instância que define o contexto da instância.
N
userIdentifier
A ID de usuário para determinar a ID de usuário exclusiva do Adaptive Planning. Valores possíveis: userName, wid, userGuid.
S
Solicitação de amostra:
HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?userIdentifier=userName
Corpo da solicitação de amostra
Corpo da solicitação POST de amostra
 
[  
  {  
      "userName": "sampleuser1@company.com",
          "permissionSet": [
                  {
                      "name": "samplePermissionSet1"
                  }
      ]
  },
  {
      "userName": "sampleuser2@company.com",
          "permissionSet": [
                  {
                      "name": "samplePermissionSet2"
                  }
          ]
  },
  {
      "userName": "sampleuser3@company.com",
          "permissionSet": [
                  {
                      "name": "samplePermissionSet3"
                  }
          ]
  }
]
Parâmetros de PayLoad
Nome
Descrição
Obrigatório
wid
A ID Workday de um usuário.
N
userName
O nome de usuário (nome de logon) de um usuário.
N
userGuid
A ID de usuário exclusiva global, atribuída pelo sistema na criação.
N
nome
ID
Nome do conjunto de permissões.
ID do conjunto de permissões.
O Nome ou a ID do conjunto de permissões é obrigatório.
S