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

Artigo
09/14/2023

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

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/requests/{requestid}/certificaterequestgenerationoptions

Parâmetros de URL

Parâmetro	Descrição
requestid	Obrigatórios. O identificador GUID da solicitação do MIM CM para a qual os parâmetros de geração de solicitação de certificado devem ser recuperados.

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
204	Sem conteúdo
403	Proibido
500	Erro Interno

Cabeçalhos de resposta

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 resposta

Com êxito, retorna uma lista de objetos CertificateRequestGenerationOptions. Cada objeto CertificateRequestGenerationOptions corresponde a uma única solicitação de certificado que o cliente precisa gerar. Cada objeto tem as seguintes propriedades:

Propriedade	Descrição
Exportável	Um valor que especifica se a chave privada criada para a solicitação pode ser exportada.
FriendlyName	O nome de exibição do certificado registrado.
HashAlgorithmName	O algoritmo de hash usado ao criar a assinatura da solicitação de certificado.
KeyAlgorithmName	O algoritmo de chave pública.
KeyProtectionLevel	O nível de proteção de chave forte.
KeySize	O tamanho, em bits, da chave privada a ser gerada.
KeyStorageProviderNames	Uma lista de KSPs (provedores de armazenamento de chave) aceitáveis que podem ser usados para gerar a chave privada. Quando o primeiro KSP não pode ser usado para gerar a solicitação de certificado, qualquer um dos KSPs especificados pode ser usado até que um seja bem-sucedido.
KeyUsages	A operação que pode ser executada com a chave privada criada para esta solicitação de certificado. O valor padrão é Assinatura.
Assunto	O nome da entidade.

Observação

Mais informações sobre essas propriedades estão disponíveis na descrição da classe Windows.Security.Cryptography.Certificates.CertificateRequestProperties . Tenha em mente que não há uma correspondência um-para-um entre essa classe e objetos CertificateRequestGenerationOptions.

Exemplo

Esta seção fornece um exemplo para obter as opções de geração para uma solicitação de certificado.

Exemplo: Solicitação

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
    }
]

Compartilhar via