Obter opções de geração de pedidos de certificado

Artigo
09/14/2023

Obtém parâmetros para a geração de pedidos de certificado do lado do cliente.

Nota

Os URLs neste artigo são relativos ao nome do anfitrião escolhido durante a implementação da API, como https://api.contoso.com.

Pedir

Método	URL do Pedido
GET	/CertificateManagement/api/v1.0/requests/{requestid}/certificaterequestgenerationoptions

Parâmetros de URL

Parâmetro	Descrição
requestid	Obrigatório. O identificador GUID do pedido CM do MIM para o qual os parâmetros de geração do pedido de certificado devem ser obtidos.

Cabeçalhos do pedido

Para obter cabeçalhos de pedidos comuns, veja Cabeçalhos de pedidos HTTP e resposta nos detalhes do serviço da API REST de CM.

Corpo do pedido

Nenhum.

Resposta

Esta secção descreve a resposta.

Códigos de resposta

Código	Descrição
200	OK
204	Sem Conteúdo
403	Proibido
500	Erro Interno

Cabeçalhos de resposta

Para obter cabeçalhos de pedidos comuns, veja Cabeçalhos de pedidos HTTP e resposta nos detalhes do serviço da API REST de CM.

Corpo da resposta

Com êxito, devolve uma lista de objetos CertificateRequestGenerationOptions. Cada objeto CertificateRequestGenerationOptions corresponde a um único pedido de certificado que o cliente tem de gerar. Cada objeto tem as seguintes propriedades:

Propriedade	Descrição
Exportável	Um valor que especifica se a chave privada criada para o pedido pode ser exportada.
FriendlyName	O nome a apresentar do certificado inscrito.
HashAlgorithmName	O algoritmo hash utilizado na criação da assinatura do pedido de certificado.
KeyAlgorithmName	O algoritmo de chave pública.
KeyProtectionLevel	O nível de proteção de chave forte.
Tamanho da Chave	O tamanho, em bits, da chave privada a ser gerada.
KeyStorageProviderNames	Uma lista de fornecedores de armazenamento de chaves aceitáveis (KSPs) que podem ser utilizados para gerar a chave privada. Quando o primeiro KSP não pode ser utilizado para gerar o pedido de certificado, qualquer um dos KSPs especificados pode ser utilizado até que um seja bem-sucedido.
KeyUsages	A operação que pode ser executada pela chave privada criada para este pedido de certificado. O valor predefinido é Assinatura.
Assunto	O nome do requerente.

Nota

Estão disponíveis mais informações sobre estas propriedades na descrição da classe Windows.Security.Cryptography.Certificates.CertificateRequestProperties . Tenha em atenção que não existe uma correspondência um-para-um entre esta classe e objetos CertificateRequestGenerationOptions.

Exemplo

Esta secção fornece um exemplo para obter as opções de geração de um pedido de certificado.

Exemplo: Pedido

GET /certificatemanagement/api/v1.0/requests/a9b4b42c-cc50-4c9b-89d1-bbc0bcd5a099/certificaterequestgenerationoptions HTTP/1.1

Exemplo: Resposta

HTTP/1.1 200 OK

[
    {
        "Subject":"",
        "KeyAlgorithmName":"RSA",
        "KeySize":2048,
        "FriendlyName":"",
        "HashAlgorithmName":"SHA1",
        "KeyStorageProviderNames":[
            "Contoso Smart Card Key Storage Provider"
        ],
        "Exportable":0,
        "KeyProtectionLevel":0,
        "KeyUsages":3
    }
]

Partilhar via