User - Get Shared Access Token

Service:

API Management

API Version:

2021-08-01

Mendapatkan Token Otorisasi Akses Bersama untuk Pengguna.

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

Parameter URI

Name	In	Required	Type	Description
resourceGroupName	path	True	string	Nama grup sumber daya.
serviceName	path	True	string	Nama layanan API Management. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Info masuk langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
userId	path	True	string	Pengidentifikasi pengguna. Harus unik dalam instans layanan API Management saat ini.
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan klien.

Isi Permintaan

Name	Required	Type	Description
properties.expiry	True	string	Waktu kedaluwarsa Token. Waktu kedaluwarsa token maksimum diatur ke 30 hari. Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.
properties.keyType	True	KeyType	Kunci yang akan digunakan untuk menghasilkan token bagi pengguna.

Respons

Name	Type	Description
200 OK	UserTokenResult	Isi respons berisi token otorisasi untuk pengguna.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

ApiManagementUserToken

Sample Request

HTTP

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

{
  "properties": {
    "keyType": "primary",
    "expiry": "2019-04-21T00:44:24.2845269Z"
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.apimanagement.models.KeyType;
import com.azure.resourcemanager.apimanagement.models.UserTokenParameters;
import java.time.OffsetDateTime;

/** Samples for User GetSharedAccessToken. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUserToken.json
     */
    /**
     * Sample code: ApiManagementUserToken.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUserToken(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .users()
            .getSharedAccessTokenWithResponse(
                "rg1",
                "apimService1",
                "userId1718",
                new UserTokenParameters()
                    .withKeyType(KeyType.PRIMARY)
                    .withExpiry(OffsetDateTime.parse("2019-04-21T00:44:24.2845269Z")),
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Go

package armapimanagement_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUserToken.json
func ExampleUserClient_GetSharedAccessToken() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armapimanagement.NewUserClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetSharedAccessToken(ctx,
		"rg1",
		"apimService1",
		"userId1718",
		armapimanagement.UserTokenParameters{
			Properties: &armapimanagement.UserTokenParameterProperties{
				Expiry:  to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-04-21T00:44:24.2845269Z"); return t }()),
				KeyType: to.Ptr(armapimanagement.KeyTypePrimary),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "value": "userId1718&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}

Definisi

ErrorFieldContract	Kontrak Bidang Kesalahan.
ErrorResponse	Respons Kesalahan.
KeyType	Kunci yang akan digunakan untuk menghasilkan token bagi pengguna.
UserTokenParameters	Mendapatkan parameter Token Pengguna.
UserTokenResult	Dapatkan detail respons Token Pengguna.

ErrorFieldContract

Kontrak Bidang Kesalahan.

Name	Type	Description
code	string	Kode kesalahan tingkat properti.
message	string	Representasi kesalahan tingkat properti yang dapat dibaca manusia.
target	string	Nama properti.

ErrorResponse

Respons Kesalahan.

Name	Type	Description
error.code	string	Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.
error.details	ErrorFieldContract[]	Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.
error.message	string	Representasi kesalahan yang dapat dibaca manusia.

KeyType

Kunci yang akan digunakan untuk menghasilkan token bagi pengguna.

Name	Type	Description
primary	string
secondary	string

UserTokenParameters

Mendapatkan parameter Token Pengguna.

Name	Type	Default Value	Description
properties.expiry	string		Waktu kedaluwarsa Token. Waktu kedaluwarsa token maksimum diatur ke 30 hari. Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.
properties.keyType	KeyType	primary	Kunci yang akan digunakan untuk menghasilkan token bagi pengguna.

UserTokenResult

Dapatkan detail respons Token Pengguna.

Name	Type	Description
value	string	Token Otorisasi Akses Bersama untuk Pengguna.