Invoke-AzConfluentInviteAccessUser
This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus .
Invite user to the organization
Syntax
InviteExpanded (Default)
Invoke-AzConfluentInviteAccessUser
-OrganizationName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-Email <String>]
[-InvitedUserDetailAuthType <String>]
[-InvitedUserDetailInvitedEmail <String>]
[-OrganizationId <String>]
[-Upn <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InviteViaJsonString
Invoke-AzConfluentInviteAccessUser
-OrganizationName <String>
-ResourceGroupName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InviteViaJsonFilePath
Invoke-AzConfluentInviteAccessUser
-OrganizationName <String>
-ResourceGroupName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Invite
Invoke-AzConfluentInviteAccessUser
-OrganizationName <String>
-ResourceGroupName <String>
-Body <IAccessInviteUserAccountModel>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InviteViaIdentityExpanded
Invoke-AzConfluentInviteAccessUser
-InputObject <IConfluentIdentity>
[-Email <String>]
[-InvitedUserDetailAuthType <String>]
[-InvitedUserDetailInvitedEmail <String>]
[-OrganizationId <String>]
[-Upn <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InviteViaIdentity
Invoke-AzConfluentInviteAccessUser
-InputObject <IConfluentIdentity>
-Body <IAccessInviteUserAccountModel>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Invite user to the organization
Examples
Example 1: Invite user to the organization
Invoke-AzConfluentInviteAccessUser `
-OrganizationName "sharedrp-scus-org" `
-ResourceGroupName "sharedrp-confluent" `
-JsonString '{
"email": "caller@contoso.com",
"upn": "caller@contoso.com",
"organizationId": "<confluent-org-id>",
"invitedUserDetails": {
"invitedEmail": "newuser@contoso.com",
"auth_type": "AUTH_TYPE_SSO"
}
}'
AcceptedAt : 2026-03-07T13:59:56.6238+00:00
AuthType : AUTH_TYPE_SSO
Email : newuser@contoso.com
ExpiresAt : 2026-03-10T13:59:56.602737+00:00
Id : i-exampleinv05
Kind : Invitation
MetadataCreatedAt : 2026-03-07T13:59:56.602737+00:00
MetadataDeletedAt :
MetadataResourceName : crn://example.confluent.io/organization=00000000-0000-0000-0000-000000000000/invitation=i-exampleinv05
MetadataSelf : https://api.example.confluent.io/iam/v2/invitations/i-exampleinv05
MetadataUpdatedAt :
ResourceGroupName :
Status : INVITE_STATUS_ACCEPTED
This command Invite User to organization
Parameters
-Body
Invite User Account model
Parameter properties
Type: Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IAccessInviteUserAccountModel
Default value: None Supports wildcards: False DontShow: False
Parameter sets
Invite
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
InviteViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Email
Email of the logged in user
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
Type: Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IConfluentIdentity
Default value: None Supports wildcards: False DontShow: False
InviteViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
InviteViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-InvitedUserDetailAuthType
Auth type of the user
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-InvitedUserDetailInvitedEmail
UPN/Email of the user who is being invited
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonFilePath
Path of Json file supplied to the Invite operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonString
Json string supplied to the Invite operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OrganizationId
Id of the organization
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OrganizationName
Organization resource name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Invite
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Invite
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
The value must be an UUID.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaJsonString
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaJsonFilePath
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Invite
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Upn
Upn of the logged in user
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
InviteExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
InviteViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IAccessInviteUserAccountModel
Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IConfluentIdentity
Outputs
Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IInvitationRecord
