Service Principals - Create

Referensi

Service:: Graph

API Version:: 7.1-preview.1

Mewujudkan perwakilan layanan AAD yang ada ke dalam akun ADO.

CATATAN: Perwakilan layanan yang dibuat tidak aktif di akun.

Menambahkan perwakilan layanan ke akun diperlukan sebelum perwakilan layanan dapat ditambahkan ke grup ADO atau menetapkan aset.

Isi permintaan harus merupakan jenis turunan dari GraphServicePrincipalCreationContext:

GraphServicePrincipalOriginIdCreationContext - Buat perwakilan layanan baru menggunakan OriginID sebagai referensi ke perwakilan layanan yang ada dari penyedia yang didukung AAD.

Jika perwakilan layanan yang akan ditambahkan sesuai dengan perwakilan layanan yang sebelumnya dihapus, maka perwakilan layanan tersebut akan dipulihkan.

Secara opsional, Anda dapat menambahkan perwakilan layanan yang baru dibuat sebagai anggota grup ADO yang ada dan/atau menentukan kunci penyimpanan kustom untuk perwakilan layanan.

POST https://vssps.dev.azure.com/{organization}/_apis/graph/serviceprincipals?api-version=7.1-preview.1

With optional parameters:

POST https://vssps.dev.azure.com/{organization}/_apis/graph/serviceprincipals?groupDescriptors={groupDescriptors}&api-version=7.1-preview.1

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
organization	path	True	string	Nama organisasi Azure DevOps.
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '7.1-preview.1' untuk menggunakan versi api ini.
groupDescriptors	query		string array (string)	Daftar deskriptor grup yang dipisahkan koma yang Anda inginkan untuk bergabung dengan perwakilan layanan grafik

Isi Permintaan

Nama	Jenis	Deskripsi
storageKey	string	Opsional: Jika disediakan, kami akan menggunakan pengidentifikasi ini untuk kunci penyimpanan perwakilan layanan yang dibuat

Respons

Nama	Jenis	Deskripsi
200 OK	GraphServicePrincipal	operasi berhasil

Keamanan

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Nama	Deskripsi
vso.graph_manage	Memberikan kemampuan untuk membaca informasi keanggotaan pengguna, grup, cakupan, dan grup, dan untuk menambahkan pengguna, grup, dan mengelola keanggotaan grup

Contoh

Sample Request

HTTP

POST https://vssps.dev.azure.com/{organization}/_apis/graph/serviceprincipals?api-version=7.1-preview.1

{
  "originId": "053b9e43-b344-4d53-897f-fe5d9c016625"
}

Sample Response

Status code:: 201

{
  "subjectKind": "servicePrincipal",
  "applicationId": "7adff1a5-9d3f-407d-8b79-4dd547d472b1",
  "directoryAlias": "053b9e43-b344-4d53-897f-fe5d9c016625",
  "domain": "62e2ee3f-dbd4-48d8-9b85-4a3776783e13",
  "principalName": "053b9e43-b344-4d53-897f-fe5d9c016625",
  "mailAddress": null,
  "origin": "aad",
  "originId": "053b9e43-b344-4d53-897f-fe5d9c016625",
  "displayName": "ServicePrincipalDisplayName",
  "_links": {
    "self": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.ZTM1NTU0YzUtMjg2MC03MWFkLWIzYjAtNzkzNWViMDg1Njg3"
    },
    "memberships": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aadsp.ZTM1NTU0YzUtMjg2MC03MWFkLWIzYjAtNzkzNWViMDg1Njg3"
    },
    "membershipState": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aadsp.ZTM1NTU0YzUtMjg2MC03MWFkLWIzYjAtNzkzNWViMDg1Njg3"
    },
    "storageKey": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aadsp.ZTM1NTU0YzUtMjg2MC03MWFkLWIzYjAtNzkzNWViMDg1Njg3"
    },
    "avatar": {
      "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aadsp.ZTM1NTU0YzUtMjg2MC03MWFkLWIzYjAtNzkzNWViMDg1Njg3"
    }
  },
  "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.ZTM1NTU0YzUtMjg2MC03MWFkLWIzYjAtNzkzNWViMDg1Njg3",
  "descriptor": "aadsp.ZTM1NTU0YzUtMjg2MC03MWFkLWIzYjAtNzkzNWViMDg1Njg3"
}

Definisi

Nama	Deskripsi
GraphServicePrincipal
GraphServicePrincipalCreationContext	Jangan coba menggunakan jenis ini untuk membuat perwakilan layanan baru. Gunakan salah satu subkelas sebagai gantinya. Tipe ini tidak berisi bidang yang memadai untuk membuat perwakilan layanan baru.
ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.

GraphServicePrincipal

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Bidang ini berisi nol atau lebih tautan menarik tentang subjek grafik. Tautan ini dapat dipanggil untuk mendapatkan hubungan tambahan atau informasi lebih rinci tentang subjek grafik ini.
applicationId	string
descriptor	string	Deskriptor adalah cara utama untuk mereferensikan subjek grafik saat sistem berjalan. Bidang ini akan mengidentifikasi subjek grafik yang sama secara unik di seluruh Akun dan Organisasi.
directoryAlias	string	Nama pendek yang umumnya unik untuk pengguna di direktori cadangan. Untuk pengguna AAD, ini sesuai dengan nama panggilan email, yang sering tetapi tidak selalu mirip dengan bagian alamat email pengguna sebelum tanda @. Untuk pengguna GitHub, ini sesuai dengan handel pengguna GitHub.
displayName	string	Ini adalah nama tampilan subjek grafik yang tidak unik. Untuk mengubah bidang ini, Anda harus mengubah nilainya di penyedia sumber.
domain	string	Ini mewakili nama kontainer asal untuk anggota grafik. (Untuk MSA ini adalah "Windows Live ID", untuk AD nama domain, untuk AAD tenantID direktori, untuk VSTS mengelompokkan ScopeId, dll)
isDeletedInOrigin	boolean	Jika true, grup telah dihapus di IdP
legacyDescriptor	string	[Penggunaan Internal Saja] Deskriptor warisan ada di sini jika Anda perlu mengakses IMS versi lama menggunakan deskriptor identitas.
mailAddress	string	Alamat email rekaman untuk anggota grafik tertentu. Ini mungkin berbeda dari nama utama.
metaType	string	Jenis meta pengguna di asal, seperti "anggota", "tamu", dll. Lihat UserMetaType untuk kumpulan nilai yang mungkin.
origin	string	Jenis penyedia sumber untuk pengidentifikasi asal (misalnya: AD, AAD, MSA)
originId	string	Pengidentifikasi unik dari sistem asal. Biasanya sid, id objek, atau Guid. Menautkan dan membatalkan tautan operasi dapat menyebabkan nilai ini berubah untuk pengguna karena pengguna tidak didukung oleh penyedia yang berbeda dan memiliki id unik yang berbeda di penyedia baru.
principalName	string	Ini adalah PrincipalName anggota grafik ini dari penyedia sumber. Penyedia sumber dapat mengubah bidang ini dari waktu ke waktu dan tidak dijamin tidak dapat diubah selama masa pakai anggota grafik oleh VSTS.
subjectKind	string	Bidang ini mengidentifikasi jenis subjek grafik (misalnya: Grup, Cakupan, Pengguna).
url	string	Url ini adalah rute lengkap ke sumber daya sumber subjek grafik ini.

GraphServicePrincipalCreationContext

Jangan coba menggunakan jenis ini untuk membuat perwakilan layanan baru. Gunakan salah satu subkelas sebagai gantinya. Tipe ini tidak berisi bidang yang memadai untuk membuat perwakilan layanan baru.

Nama	Jenis	Deskripsi
storageKey	string	Opsional: Jika disediakan, kami akan menggunakan pengidentifikasi ini untuk kunci penyimpanan perwakilan layanan yang dibuat

ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.

Nama	Jenis	Deskripsi
links	object	Tampilan baca-saja dari tautan. Karena tautan Referensi bersifat baca-saja, kami hanya ingin mengeksposnya sebagai baca-saja.

Bagikan melalui