Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda/ Identity and Access Management/ Referência de API/ API/ Gerenciamento de autenticação de identidade federada/ Protocolos/ Registro de um protocolo
Atualizado em 2024-08-31 GMT+08:00
Ver PDF
Compartilhar

Registro de um protocolo

Função

Essa API é fornecida para o administrador vincular um protocolo a um provedor de identidade após a criação do provedor de identidade.

A API pode ser chamada usando o ponto de extremidade global e pontos de extremidade da região específica. Para pontos de extremidade do IAM, consulte Regiões e pontos de extremidade.

URI

PUT /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}

Tabela 1 Parâmetros de URI

Parâmetro

Obrigatório

Tipo

Descrição

idp_id

Sim

String

Nome do provedor de identidade.

protocol_id

Sim

String

ID do protocolo a ser registrado. O valor deste campo pode ser saml ou oidc.

Parâmetros de solicitação

Tabela 2 Parâmetros no cabeçalho da solicitação

Parâmetro

Obrigatório

Tipo

Descrição

X-Auth-Token

Sim

String

Token de acesso emitido para um usuário para suportar sua identidade e permissões.

Para obter detalhes sobre as permissões exigidas pelo token, consulte Ações.
Tabela 3 Parâmetros no corpo da solicitação

Parâmetro

Obrigatório

Tipo

Descrição

protocol

Sim

Object

Informações de protocolo.
Tabela 4 protocol

Parâmetro

Obrigatório

Tipo

Descrição

mapping_id

Não

String

ID de mapeamento.

Parâmetros de resposta

Tabela 5 Parâmetros no corpo da resposta

Parâmetro

Tipo

Descrição

protocol

Object

Informações de protocolo.
Tabela 6 protocol

Parâmetro

Tipo

Descrição

id

String

ID do protocolo. O valor desse campo pode ser saml ou oidc.

mapping_id

String

ID de mapeamento.

links

Object

Informações sobre link de recurso de protocolo.
Tabela 7 protocol.links

Parâmetro

Tipo

Descrição

identity_provider

String

Link de recurso do provedor de identidade.

self

String

Link de recurso.

Exemplo de solicitação

Solicitação para registrar um protocolo

PUT https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
{
    "protocol": {
        "mapping_id": "ACME"
    }
}

Exemplo de resposta

Código de status: 201

A solicitação foi bem-sucedida.

{
    "protocol": {
        "mapping_id": "ACME",
        "id": "saml",
        "links": {
            "self": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME/protocols/saml",
            "identity_provider": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME"
        }
    }
}

Códigos de status

Código de status

Descrição

201

A solicitação foi bem-sucedida.

400

Parâmetros inválidos.

401

Falha na autenticação.

403

Acesso negado.

404

O recurso solicitado não pode ser encontrado.

405

O método especificado na solicitação não é permitido para o recurso solicitado.

413

A entidade de solicitação é muito grande.

500

Erro de servidor interno.

503

Serviço indisponível.

Códigos de erro

Nenhum

Tópico principal: Protocolos