Aracılığıyla paylaş


Access - Invite User

Kullanıcıyı kuruluşa davet etme

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

URI Parametreleri

Name İçinde Gerekli Tür Description
organizationName
path True

string

Kuruluş kaynağı adı

resourceGroupName
path True

string

Kaynak grubu adı

subscriptionId
path True

string

Microsoft Azure abonelik kimliği

api-version
query True

string

İstemci Api Sürümü.

İstek Gövdesi

Name Tür Description
email

string

Oturum açmış kullanıcının Email

invitedUserDetails

Access_InvitedUserDetails

Davet edilen kullanıcının ayrıntıları

organizationId

string

Kuruluşun kimliği

upn

string

Oturum açmış kullanıcının upn'i

Yanıtlar

Name Tür Description
200 OK

InvitationRecord

Başarılı

Other Status Codes

ResourceProviderDefaultErrorResponse

Varsayılan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

Access_InviteUser

Örnek isteği

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"
  }
}

Örnek yanıt

{
  "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"
}

Tanımlar

Name Description
Access_InvitedUserDetails

Davet edilen kullanıcının ayrıntıları

Access_InviteUserAccountModel

Kullanıcı Hesabı Modelini Davet Et

ErrorResponseBody

ErrorResponseBody

InvitationRecord

Davetin kaydı

MetadataEntity

Veri kaydının meta verileri

ResourceProviderDefaultErrorResponse

ResourceProviderDefaultErrorResponse

Access_InvitedUserDetails

Davet edilen kullanıcının ayrıntıları

Name Tür Description
auth_type

string

Kullanıcının kimlik doğrulama türü

invitedEmail

string

Davet edilen kullanıcının UPN/Email

Access_InviteUserAccountModel

Kullanıcı Hesabı Modelini Davet Et

Name Tür Description
email

string

Oturum açmış kullanıcının Email

invitedUserDetails

Access_InvitedUserDetails

Davet edilen kullanıcının ayrıntıları

organizationId

string

Kuruluşun kimliği

upn

string

Oturum açmış kullanıcının upn'i

ErrorResponseBody

ErrorResponseBody

Name Tür Description
code

string

Hata kodu

details

ErrorResponseBody[]

Hata ayrıntısı

message

string

Hata iletisi

target

string

Hata hedefi

InvitationRecord

Davetin kaydı

Name Tür Description
accepted_at

string

Davetin kabul edilen tarih saati

auth_type

string

Kullanıcının kimlik doğrulama türü

email

string

Kullanıcının Email

expires_at

string

Davetin son kullanma tarihi saati

id

string

Davetin kimliği

kind

string

Hesap türü

metadata

MetadataEntity

Kaydın meta verileri

status

string

Davetin durumu

MetadataEntity

Veri kaydının meta verileri

Name Tür Description
created_at

string

Oluşturma Tarihi Saati

deleted_at

string

Silinen Tarih saati

resource_name

string

Kaydın kaynak adı

self

string

Kendi kendine arama url'si

updated_at

string

Güncelleştirilmiş Tarih saati

ResourceProviderDefaultErrorResponse

ResourceProviderDefaultErrorResponse

Name Tür Description
error

ErrorResponseBody

ErrorResponseBody
Hatanın yanıt gövdesi