Enrollment Groups - Get X509

Service:

IoT Central

API Version:

2022-07-31

Obter o certificado x509 primário ou secundário de um grupo de registro
Obtenha detalhes sobre o certificado x509 primário ou secundário de um grupo de registro, se ele existir.

GET https://{subdomain}.{baseDomain}/api/enrollmentGroups/{enrollmentGroupId}/certificates/{entry}?api-version=2022-07-31

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
baseDomain	path	True	string	O domínio base para todas as solicitações de serviço do Azure IoT Central.
enrollmentGroupId	path	True	string	ID exclusiva do grupo de registro. Regex pattern: ^[a-zA-Z0-9-]*$
entry	path	True	CertificateEntry	A entrada de certificado dá suporte apenas a primário e secundário.
subdomain	path	True	string	O subdomínio do aplicativo.
api-version	query	True	string	A versão da API que está sendo chamada.

Respostas

Nome	Tipo	Description
200 OK	SigningX509Certificate	Êxito
Other Status Codes	Error	Uma resposta de erro recebida do Serviço do IoT Central. Headers x-ms-error-code: string

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get primary or secondary X509

Sample Request

HTTP

GET https://appsubdomain.azureiotcentral.com/api/enrollmentGroups/myEnrollmentGroupId/certificates/primary?api-version=2022-07-31

Sample Response

Status code:

200

{
  "verified": true,
  "info": {
    "sha1Thumbprint": "644543467786B60C14DFE6B7C968A1990CF63EAC"
  },
  "etag": "IjE3MDAwODNhLTAwMDAtMDcwMC0wMDAwLTYyNjFmNzk0MDAwMCI="
}

Definições

Nome	Description
CertificateEntry	A entrada de certificado dá suporte apenas a primário e secundário.
Error	A definição de erro de resposta.
ErrorDetails	As informações detalhadas do erro.
SigningX509Certificate	A definição do certificado X509.
X509CertificateInfo	As informações do certificado X509.

CertificateEntry

A entrada de certificado dá suporte apenas a primário e secundário.

Nome	Tipo	Description
primary	string	A entrada do certificado primário
secondary	string	A entrada do certificado secundário

Error

A definição de erro de resposta.

Nome	Tipo	Description
error	ErrorDetails	Detalhes do erro da solicitação atual.

ErrorDetails

As informações detalhadas do erro.

Nome	Tipo	Description
code	string	Código do erro.
message	string	Detalhes da mensagem de erro.
requestId	string	ID de correlação da solicitação atual.
time	string	A hora em que a solicitação de erro falhou.

SigningX509Certificate

A definição do certificado X509.

Nome	Tipo	Valor padrão	Description
certificate	string		A representação de cadeia de caracteres desse certificado.
etag	string		ETag usada para evitar conflitos em várias atualizações
info	X509CertificateInfo		Informações sobre esse certificado.
verified	boolean	False	Se o certificado foi verificado.

X509CertificateInfo

As informações do certificado X509.

Nome	Tipo	Description
sha1Thumbprint	string	O valor de hash SHA-1 do certificado.