Obter política de fluxo de trabalho
Obtém a política de modelo de perfil para um fluxo de trabalho especificado. Os dados são usados durante a criação da solicitação. A política de fluxo de trabalho especifica de quais dados o cliente precisa para criar uma solicitação. Os dados podem incluir vários itens de coleta de dados, comentários de solicitação e uma política de senha única.
Observação
As URLs neste artigo são relativas ao nome do host escolhido durante a implantação da API, como https://api.contoso.com.
Solicitação
| Método | URL da solicitação |
|---|---|
| GET | /CertificateManagement/api/v1.0/profiletemplates/{id}/policy/workflow/{type} |
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| id | Obrigatórios. O GUID correspondente ao modelo de perfil do qual extrair a política. |
| tipo | Obrigatórios. O tipo de política que está sendo solicitada. Os valores possíveis são "Registrar", "Duplicar", "OfflineUnblock", "OnlineUpdate", "Renovar", "Recuperar", "RecoverOnBehalf", "Restabelecer", "Desativar", "Revogar", "TemporaryEnroll" e "Desbloquear". |
Cabeçalhos da solicitação
Para cabeçalhos de solicitação comuns, consulte Cabeçalhos de solicitação e resposta HTTP nos detalhes do serviço da API REST do CM.
Corpo da solicitação
Nenhum.
Resposta
Esta seção descreve a resposta.
Códigos de resposta
| Código | Descrição |
|---|---|
| 200 | OK |
| 403 | Proibido |
| 204 | Sem conteúdo |
| 500 | Erro Interno |
Cabeçalhos de resposta
Para cabeçalhos de resposta comuns, consulte Cabeçalhos de solicitação e resposta HTTP nos detalhes do serviço da API REST do CM.
Corpo da resposta
Em caso de êxito, retorna um objeto de política baseado em um objeto ProfileTemplatePolicy . No mínimo, o objeto de política contém as propriedades na tabela a seguir, mas pode conter propriedades adicionais, dependendo da política solicitada. Por exemplo, uma solicitação para uma política de registro retorna um objeto EnrollPolicy . Para obter mais informações, consulte a documentação do objeto de política associado ao parâmetro {type} na solicitação. A documentação para os diferentes tipos de objetos de política pode ser encontrada na documentação do namespace Microsoft.Clm.Shared.ProfileTemplates .
| Propriedade | Descrição |
|---|---|
| ApprovalsNeeded | O número de aprovações necessárias para solicitações de CM (Gerenciamento de Certificados) do FIM (Forefront Identity Manager) para a política. |
| AuthorizedApprover | O descritor de segurança para os usuários autorizados a aprovar solicitações de FIM CM para a política. |
| AuthorizedEnrollmentAgent | O descritor de segurança para os usuários que podem atuar como agentes de registro para a política. |
| AuthorizedInitiator | O descritor de segurança para os usuários que podem iniciar solicitações de FIM CM para a política. |
| CollectComments | Um valor booliano que indica se a coleção de comentários está habilitada para solicitações de FIM CM para a política. |
| CollectRequestPriority | Um valor booliano que indica se a coleção de prioridade da solicitação está habilitada para solicitações de FIM CM para a política. |
| DefaultRequestPriority | A prioridade padrão para solicitações de FIM CM para a política. |
| Documentos | Os documentos de política que estão configurados para a política. |
| Habilitada | Um valor booliano que indica se a política está habilitada. |
| EnrollAgentRequired | Um valor booliano que indica se os agentes de registro são necessários para solicitações de FIM CM para a política. |
| OneTimePasswordPolicy | O método de distribuição para senhas de uso único para solicitações do FIM CM para a política. |
| Personalização | As opções de personalização de cartão inteligente para a política. |
| PolicyDataCollection | Os itens de coleta de dados associados à política. |
| SelfServiceEnabled | Um valor booliano que indica se a iniciação de autoatendimento das solicitações de FIM CM está habilitada para a política. |
Exemplo
Esta seção fornece um exemplo para obter a política de modelo de perfil para um fluxo de trabalho.
Exemplo: Solicitação 1
GET /CertificateManagement/api/v1.0/profiletemplates/97CD65FA-AF4B-4587-9309-0DD6BFD8B4E1/policies/enroll HTTP/1.1
Exemplo: Resposta 1
HTTP/1.1 200 OK
... body coming soon
Exemplo: Solicitação 2
GET /CertificateManagement/api/v1.0/profiletemplates/97CD65FA-AF4B-4587-9309-0DD6BFD8B4E1/policies/renew HTTP/1.1
Exemplo: Resposta 2
HTTP/1.1 200 OK
... body coming soon