Obter regra única

Referência de ponto de extremidade de API para recuperar uma única regra de provisionamento SAML por seu ID em uma organização do Test Cloud.

Recupera uma regra de provisionamento SAML por seu ID dentro de uma organização.

Endpoint

GET /api/Rule/{partitionGlobalId}/{ruleId}

Cabeçalhos de solicitação.

--header 'Authorization: Bearer {access_token}'
--header 'Content-Type: application/json'

Parâmetros

Name	Tipo	Location	Required	Description
partitionGlobalId	GUID	Path	Sim	O identificador global da organização. Para obter etapas sobre a recuperação de partitionGlobalId, consulte Recuperação do partialGlobalId para uso da API.
ruleId	Número inteiro	Path	Sim	O identificador exclusivo da regra

Resposta

Observação:

• Ao contrário do ponto de extremidade Obter regras em massa , o ponto de extremidade Obter regra resolve assignedGroups como objetos de grupo completos.
• definition é retornado como uma string codificada por JSON, não como um objeto analisado.
• Campos opcionais, como description, podem ser retornados como strings vazias.
• groupType é retornado como um valor numérico (enum-back).
• Campos adicionais, como mappedRole e scope, podem estar presentes, dependendo do tipo de grupo e do ambiente.

{
  "id": 2607,
  "partitionGlobalId": "00000000-0000-0000-0000-000000000000",
  "name": "Automation Users",
  "description": "",
  "enabled": true,
  "definition": "{\"GroupsToAssign\":[\"cdc34b5b-77d2-4ae1-9744-209d21ce557d\"],\"Conditions\":[{\"ClaimName\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress\",\"ConditionType\":\"Contains\",\"Value\":\"uipath.com\"}]}",
  "assignedGroups": [
    {
      "id": "cdc34b5b-77d2-4ae1-9744-209d21ce557d",
      "name": "Automation Users",
      "displayName": "Automation Users",
      "type": 0,
      "creationTime": "2021-01-22T16:29:33.7917688",
      "lastModificationTime": "2021-01-22T16:29:33.7917689",
      "members": [],
      "mappedRole": null,
      "scope": null
    }
  ]
}

Exemplo de solicitação

{
  "id": 2607,
  "partitionGlobalId": "00000000-0000-0000-0000-000000000000",
  "name": "Automation Users",
  "description": "",
  "enabled": true,
  "definition": "{\"GroupsToAssign\":[\"cdc34b5b-77d2-4ae1-9744-209d21ce557d\"],\"Conditions\":[{\"ClaimName\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress\",\"ConditionType\":\"Contains\",\"Value\":\"uipath.com\"}]}" ,
  "assignedGroups": [
    {
      "id": "cdc34b5b-77d2-4ae1-9744-209d21ce557d",
      "name": "Automation Users",
      "displayName": "Automation Users",
      "type": 0,
      "creationTime": "2021-01-22T16:29:33.7917688",
      "lastModificationTime": "2021-01-22T16:29:33.7917689",
      "members": []
    }
  ]
}