Compartilhar via


Access - Invite User

Convidar usuário para a organização

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
organizationName
path True

string

Nome do recurso da organização

resourceGroupName
path True

string

Nome do grupo de recursos

subscriptionId
path True

string

ID de assinatura do Microsoft Azure

api-version
query True

string

Versão da API do cliente.

Corpo da solicitação

Nome Tipo Description
email

string

Email do usuário conectado

invitedUserDetails

Access_InvitedUserDetails

Detalhes do usuário que está sendo convidado

organizationId

string

ID da organização

upn

string

Upn do usuário conectado

Respostas

Nome Tipo Description
200 OK

InvitationRecord

Êxito

Other Status Codes

ResourceProviderDefaultErrorResponse

Resposta de erro padrão.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

Access_InviteUser

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
Access_InvitedUserDetails

Detalhes do usuário que está sendo convidado

Access_InviteUserAccountModel

Convidar modelo de Conta de Usuário

ErrorResponseBody

ErrorResponseBody

InvitationRecord

Registro do convite

MetadataEntity

Metadados do registro de dados

ResourceProviderDefaultErrorResponse

ResourceProviderDefaultErrorResponse

Access_InvitedUserDetails

Detalhes do usuário que está sendo convidado

Nome Tipo Description
auth_type

string

Tipo de autenticação do usuário

invitedEmail

string

UPN/Email do usuário que está sendo convidado

Access_InviteUserAccountModel

Convidar modelo de Conta de Usuário

Nome Tipo Description
email

string

Email do usuário conectado

invitedUserDetails

Access_InvitedUserDetails

Detalhes do usuário que está sendo convidado

organizationId

string

ID da organização

upn

string

Upn do usuário conectado

ErrorResponseBody

ErrorResponseBody

Nome Tipo Description
code

string

Código do erro

details

ErrorResponseBody[]

Detalhes do erro

message

string

Mensagem de erro

target

string

Destino de erro

InvitationRecord

Registro do convite

Nome Tipo Description
accepted_at

string

Data aceita do convite

auth_type

string

Tipo de autenticação do usuário

email

string

Email do usuário

expires_at

string

Data de validade do convite

id

string

ID do convite

kind

string

Tipo de conta

metadata

MetadataEntity

Metadados do registro

status

string

Status do convite

MetadataEntity

Metadados do registro de dados

Nome Tipo Description
created_at

string

Hora da Data Criada

deleted_at

string

Data de data excluída

resource_name

string

Nome do recurso do registro

self

string

URL de pesquisa própria

updated_at

string

Data/hora atualizada

ResourceProviderDefaultErrorResponse

ResourceProviderDefaultErrorResponse

Nome Tipo Description
error

ErrorResponseBody

ErrorResponseBody
Corpo da resposta de Erro