Dela via


Access - Invite User

Bjud in användare till organisationen

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

URI-parametrar

Name I Obligatorisk Typ Description
organizationName
path True

string

Namn på organisationsresurs

resourceGroupName
path True

string

Namn på resursgrupp

subscriptionId
path True

string

Prenumerations-ID för Microsoft Azure

api-version
query True

string

Klient-API-version.

Begärandetext

Name Typ Description
email

string

Email för den inloggade användaren

invitedUserDetails

Access_InvitedUserDetails

Information om den användare som bjuds in

organizationId

string

ID för organisationen

upn

string

Upn för den inloggade användaren

Svar

Name Typ Description
200 OK

InvitationRecord

Klart

Other Status Codes

ResourceProviderDefaultErrorResponse

Standardfelsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

Access_InviteUser

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
Access_InvitedUserDetails

Information om användaren som bjuds in

Access_InviteUserAccountModel

Bjud in användarkontomodell

ErrorResponseBody

ErrorResponseBody

InvitationRecord

Post för inbjudan

MetadataEntity

Metadata för dataposten

ResourceProviderDefaultErrorResponse

ResourceProviderDefaultErrorResponse

Access_InvitedUserDetails

Information om användaren som bjuds in

Name Typ Description
auth_type

string

Användarens autentiseringstyp

invitedEmail

string

UPN/Email för den användare som bjuds in

Access_InviteUserAccountModel

Bjud in användarkontomodell

Name Typ Description
email

string

Email för den inloggade användaren

invitedUserDetails

Access_InvitedUserDetails

Information om den användare som bjuds in

organizationId

string

ID för organisationen

upn

string

Upn för den inloggade användaren

ErrorResponseBody

ErrorResponseBody

Name Typ Description
code

string

Felkod

details

ErrorResponseBody[]

Felinformation

message

string

Felmeddelande

target

string

Felmål

InvitationRecord

Post för inbjudan

Name Typ Description
accepted_at

string

Accepterad datumtid för inbjudan

auth_type

string

Användarens autentiseringstyp

email

string

användarens Email

expires_at

string

Förfallodatum för inbjudan

id

string

ID för inbjudan

kind

string

Typ av konto

metadata

MetadataEntity

Metadata för posten

status

string

Status för inbjudan

MetadataEntity

Metadata för dataposten

Name Typ Description
created_at

string

Skapad datumtid

deleted_at

string

Borttagen datumtid

resource_name

string

Resursnamn för posten

self

string

Url för självuppslag

updated_at

string

Uppdaterad datumtid

ResourceProviderDefaultErrorResponse

ResourceProviderDefaultErrorResponse

Name Typ Description
error

ErrorResponseBody

ErrorResponseBody
Svarstext för fel