Recupera uma URL de redirecionamento que contém um token de autenticação para assinar um determinado usuário no portal do desenvolvedor.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/generateSsoUrl?api-version=2022-08-01
Parâmetros de URI
| Nome |
Em |
Obrigatório |
Tipo |
Description |
|
resourceGroupName
|
path |
True
|
string
|
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
|
|
serviceName
|
path |
True
|
string
|
O nome do serviço Gerenciamento de API.
Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
|
|
subscriptionId
|
path |
True
|
string
|
A ID da assinatura de destino.
|
|
userId
|
path |
True
|
string
|
Identificador do usuário. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
|
|
api-version
|
query |
True
|
string
|
A versão da API a ser usada para esta operação.
|
Respostas
| Nome |
Tipo |
Description |
|
200 OK
|
GenerateSsoUrlResult
|
O corpo de resposta contém a URL de logon único.
|
|
Other Status Codes
|
ErrorResponse
|
Resposta de erro que descreve por que a operação falhou.
|
Segurança
azure_auth
Fluxo 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
ApiManagementUserGenerateSsoUrl
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7/generateSsoUrl?api-version=2022-08-01
/** Samples for User GenerateSsoUrl. */
public final class Main {
/*
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUserGenerateSsoUrl.json
*/
/**
* Sample code: ApiManagementUserGenerateSsoUrl.
*
* @param manager Entry point to ApiManagementManager.
*/
public static void apiManagementUserGenerateSsoUrl(
com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
manager
.users()
.generateSsoUrlWithResponse(
"rg1", "apimService1", "57127d485157a511ace86ae7", com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-apimanagement
# USAGE
python api_management_user_generate_sso_url.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = ApiManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.user.generate_sso_url(
resource_group_name="rg1",
service_name="apimService1",
user_id="57127d485157a511ace86ae7",
)
print(response)
# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUserGenerateSsoUrl.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armapimanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUserGenerateSsoUrl.json
func ExampleUserClient_GenerateSsoURL() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewUserClient().GenerateSsoURL(ctx, "rg1", "apimService1", "57127d485157a511ace86ae7", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.GenerateSsoURLResult = armapimanagement.GenerateSsoURLResult{
// Value: to.Ptr("https://apimService1.portal.azure-api.net/signin-sso?token=57127d485157a511ace86ae7%26201706051624%267VY18MlwAom***********2bYr2bDQHg21OzQsNakExQ%3d%3d"),
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.
*
* @summary Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUserGenerateSsoUrl.json
*/
async function apiManagementUserGenerateSsoUrl() {
const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
const serviceName = "apimService1";
const userId = "57127d485157a511ace86ae7";
const credential = new DefaultAzureCredential();
const client = new ApiManagementClient(credential, subscriptionId);
const result = await client.user.generateSsoUrl(resourceGroupName, serviceName, userId);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"value": "https://apimService1.portal.azure-api.net/signin-sso?token=57127d485157a511ace86ae7%26201706051624%267VY18MlwAom***********2bYr2bDQHg21OzQsNakExQ%3d%3d"
}
Definições
ErrorFieldContract
Contrato de Campo de Erro.
| Nome |
Tipo |
Description |
|
code
|
string
|
Código de erro no nível da propriedade.
|
|
message
|
string
|
Representação legível por humanos do erro no nível da propriedade.
|
|
target
|
string
|
Nome da propriedade.
|
ErrorResponse
Resposta de erro.
| Nome |
Tipo |
Description |
|
error.code
|
string
|
Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.
|
|
error.details
|
ErrorFieldContract[]
|
A lista de campos inválidos enviados na solicitação, em caso de erro de validação.
|
|
error.message
|
string
|
Representação legível ao olho humano do erro.
|
GenerateSsoUrlResult
Gerar detalhes de resposta de operações de URL de SSO.
| Nome |
Tipo |
Description |
|
value
|
string
|
Url de redirecionamento que contém o valor da URL de SSO.
|