Freigeben über


Access - Invite User

Benutzer zum organization einladen

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
organizationName
path True

string

Organisationsressourcenname

resourceGroupName
path True

string

Ressourcengruppenname

subscriptionId
path True

string

Microsoft Azure-Abonnement-ID

api-version
query True

string

Client-API-Version.

Anforderungstext

Name Typ Beschreibung
email

string

Email des angemeldeten Benutzers

invitedUserDetails

Access_InvitedUserDetails

Details des Benutzers, der eingeladen wird

organizationId

string

ID des organization

upn

string

Upn des angemeldeten Benutzers

Antworten

Name Typ Beschreibung
200 OK

InvitationRecord

Erfolg

Other Status Codes

ResourceProviderDefaultErrorResponse

Standardfehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

Access_InviteUser

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
Access_InvitedUserDetails

Details des eingeladenen Benutzers

Access_InviteUserAccountModel

Benutzerkontomodell einladen

ErrorResponseBody

ErrorResponseBody

InvitationRecord

Aufzeichnung der Einladung

MetadataEntity

Metadaten des Datensatzes

ResourceProviderDefaultErrorResponse

ResourceProviderDefaultErrorResponse

Access_InvitedUserDetails

Details des eingeladenen Benutzers

Name Typ Beschreibung
auth_type

string

Authentifizierungstyp des Benutzers

invitedEmail

string

UPN/Email des eingeladenen Benutzers

Access_InviteUserAccountModel

Benutzerkontomodell einladen

Name Typ Beschreibung
email

string

Email des angemeldeten Benutzers

invitedUserDetails

Access_InvitedUserDetails

Details des Benutzers, der eingeladen wird

organizationId

string

ID des organization

upn

string

Upn des angemeldeten Benutzers

ErrorResponseBody

ErrorResponseBody

Name Typ Beschreibung
code

string

Fehlercode

details

ErrorResponseBody[]

Fehlerdetail

message

string

Fehlermeldung

target

string

Fehlerziel

InvitationRecord

Aufzeichnung der Einladung

Name Typ Beschreibung
accepted_at

string

Akzeptierte Uhrzeit der Einladung

auth_type

string

Authentifizierungstyp des Benutzers

email

string

Email des Benutzers

expires_at

string

Ablaufdatum der Einladung

id

string

ID der Einladung

kind

string

Kontotyp

metadata

MetadataEntity

Metadaten des Datensatzes

status

string

Status der Einladung

MetadataEntity

Metadaten des Datensatzes

Name Typ Beschreibung
created_at

string

Erstellungsdatum Uhrzeit

deleted_at

string

Uhrzeit des Gelöschten Datums

resource_name

string

Ressourcenname des Datensatzes

self

string

Url für die Selbstsuche

updated_at

string

Datumszeit aktualisiert

ResourceProviderDefaultErrorResponse

ResourceProviderDefaultErrorResponse

Name Typ Beschreibung
error

ErrorResponseBody

ErrorResponseBody
Antworttext des Fehlers