Partilhar via


User - Generate Sso Url

Obtém um URL de redirecionamento que contém um token de autenticação para assinar um determinado utilizador no portal do programador.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/generateSsoUrl?api-version=2021-08-01

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos.

serviceName
path True

string

O nome do serviço Gestão de API.

Padrão Regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.

userId
path True

string

Identificador de utilizador. Tem de ser exclusivo na instância de serviço de Gestão de API atual.

api-version
query True

string

Versão da API a utilizar com o pedido de cliente.

Respostas

Name Tipo Description
200 OK

GenerateSsoUrlResult

O corpo da resposta contém o URL de início de sessão único.

Other Status Codes

ErrorResponse

Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

ApiManagementUserGenerateSsoUrl

Pedido de amostra

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7/generateSsoUrl?api-version=2021-08-01

Resposta da amostra

{
  "value": "https://apimService1.portal.azure-api.net/signin-sso?token=57127d485157a511ace86ae7%26201706051624%267VY18MlwAom***********2bYr2bDQHg21OzQsNakExQ%3d%3d"
}

Definições

Name Description
ErrorFieldContract

Contrato de campo de erro.

ErrorResponse

Resposta a Erros.

GenerateSsoUrlResult

Gerar detalhes de resposta de operações de URL de SSO.

ErrorFieldContract

Contrato de campo de erro.

Name Tipo Description
code

string

Código de erro ao nível da propriedade.

message

string

Representação legível por humanos do erro ao nível da propriedade.

target

string

Nome da propriedade.

ErrorResponse

Resposta a Erros.

Name Tipo Description
error.code

string

Código de erro definido pelo serviço. Este código serve como um sub-estado para o código de erro HTTP especificado na resposta.

error.details

ErrorFieldContract[]

A lista de campos inválidos enviados a pedido, em caso de erro de validação.

error.message

string

Representação legível por humanos do erro.

GenerateSsoUrlResult

Gerar detalhes de resposta de operações de URL de SSO.

Name Tipo Description
value

string

Url de Redirecionamento que contém o valor de URL do SSO.