Bagikan melalui


Access - Invite User

Mengundang pengguna ke organisasi

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/createInvitation?api-version=2024-02-13

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
organizationName
path True

string

Nama sumber daya organisasi

resourceGroupName
path True

string

Nama grup sumber daya

subscriptionId
path True

string

Id langganan Microsoft Azure

api-version
query True

string

Versi Api Klien.

Isi Permintaan

Nama Jenis Deskripsi
email

string

Email pengguna yang masuk

invitedUserDetails

Access_InvitedUserDetails

Detail pengguna yang sedang diundang

organizationId

string

Id organisasi

upn

string

Upn pengguna yang masuk

Respons

Nama Jenis Deskripsi
200 OK

InvitationRecord

Berhasil

Other Status Codes

ResourceProviderDefaultErrorResponse

Respons kesalahan default.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

Access_InviteUser

Permintaan sampel

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization/access/default/createInvitation?api-version=2024-02-13

{
  "invitedUserDetails": {
    "invitedEmail": "user2@onmicrosoft.com",
    "auth_type": "AUTH_TYPE_SSO"
  }
}

Respon sampel

{
  "kind": "Invitation",
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/iam/v2/invitations/i-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/invitation=i-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "email": "johndoe@confluent.io",
  "auth_type": "AUTH_TYPE_SSO",
  "status": "INVITE_STATUS_SENT",
  "accepted_at": "2022-07-06T17:21:33Z",
  "expires_at": "2022-07-07T17:22:39Z"
}

Definisi

Nama Deskripsi
Access_InvitedUserDetails

Detail pengguna yang diundang

Access_InviteUserAccountModel

Mengundang model Akun Pengguna

ErrorResponseBody

ErrorResponseBody

InvitationRecord

Catatan undangan

MetadataEntity

Metadata rekaman data

ResourceProviderDefaultErrorResponse

ResourceProviderDefaultErrorResponse

Access_InvitedUserDetails

Detail pengguna yang diundang

Nama Jenis Deskripsi
auth_type

string

Jenis Autentikasi pengguna

invitedEmail

string

UPN/Email pengguna yang sedang diundang

Access_InviteUserAccountModel

Mengundang model Akun Pengguna

Nama Jenis Deskripsi
email

string

Email pengguna yang masuk

invitedUserDetails

Access_InvitedUserDetails

Detail pengguna yang sedang diundang

organizationId

string

Id organisasi

upn

string

Upn pengguna yang masuk

ErrorResponseBody

ErrorResponseBody

Nama Jenis Deskripsi
code

string

Kode kesalahan

details

ErrorResponseBody[]

Detail kesalahan

message

string

Pesan kesalahan

target

string

Target kesalahan

InvitationRecord

Catatan undangan

Nama Jenis Deskripsi
accepted_at

string

Waktu tanggal undangan yang diterima

auth_type

string

Jenis Autentikasi pengguna

email

string

Email pengguna

expires_at

string

Waktu tanggal kedaluwarsa undangan

id

string

Id undangan

kind

string

Jenis akun

metadata

MetadataEntity

Metadata rekaman

status

string

Status undangan

MetadataEntity

Metadata rekaman data

Nama Jenis Deskripsi
created_at

string

Waktu Tanggal Dibuat

deleted_at

string

Waktu Tanggal Dihapus

resource_name

string

Nama sumber daya rekaman

self

string

Url pencarian mandiri

updated_at

string

Waktu Tanggal Diperbarui

ResourceProviderDefaultErrorResponse

ResourceProviderDefaultErrorResponse

Nama Jenis Deskripsi
error

ErrorResponseBody

ErrorResponseBody
Isi respons Kesalahan