Edit

Get-AzConfluentAccessInvitation

  • Preview
Module:
Az.Confluent Module

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.

Organization accounts invitation details

Syntax

ListExpanded (Default) 

Get-AzConfluentAccessInvitation
    -OrganizationName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-SearchFilter <Hashtable>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

List 

Get-AzConfluentAccessInvitation
    -OrganizationName <String>
    -ResourceGroupName <String>
    -Body <IListAccessRequestModel>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ListViaJsonFilePath 

Get-AzConfluentAccessInvitation
    -OrganizationName <String>
    -ResourceGroupName <String>
    -JsonFilePath <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ListViaJsonString 

Get-AzConfluentAccessInvitation
    -OrganizationName <String>
    -ResourceGroupName <String>
    -JsonString <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Organization accounts invitation details

Examples

Example 1: List all Invitation under organization in the resource group

Get-AzConfluentAccessInvitation -OrganizationName sharedrp-scus-org -ResourceGroupName sharedrp-confluent

Data              : {{
                      "metadata": {
                        "self": "https://api.example.confluent.io/iam/v2/invitations/i-exampleinv04",
                        "resource_name": "crn://example.confluent.io/organization=00000000-0000-0000-0000-000000000000/invitation=i-exampleinv04",
                        "created_at": "2025-11-13T10:57:08.617671+00:00",
                        "updated_at": "2025-11-13T10:57:08.625073+00:00"
                      },
                      "kind": "Invitation",
                      "id": "i-exampleinv04",
                      "email": "user5@example.com",
                      "auth_type": "AUTH_TYPE_SSO",
                      "status": "INVITE_STATUS_ACCEPTED",
                      "accepted_at": "2025-11-13T13:28:01.219263+00:00",
                      "expires_at": "2025-11-16T10:57:08.625073+00:00"
                    }, {
                      "metadata": {
                        "self": "https://api.example.confluent.io/iam/v2/invitations/i-exampleinv02",
                        "resource_name": "crn://example.confluent.io/organization=00000000-0000-0000-0000-000000000000/invitation=i-exampleinv02",
                        "created_at": "2025-11-13T10:59:01.206099+00:00",
                        "updated_at": "2025-11-13T10:59:01.214239+00:00"
                      },
                      "kind": "Invitation",
                      "id": "i-exampleinv02",
                      "email": "user6@example.com",
                      "auth_type": "AUTH_TYPE_SSO",
                      "status": "INVITE_STATUS_EXPIRED",
                      "accepted_at": "0001-01-01T00:00:00+00:00",
                      "expires_at": "2025-11-16T10:59:01.214239+00:00"
                    }, {
                      "metadata": {
                        "self": "https://api.example.confluent.io/iam/v2/invitations/i-exampleinv03",
                        "resource_name": "crn://example.confluent.io/organization=00000000-0000-0000-0000-000000000000/invitation=i-exampleinv03",
                        "created_at": "2025-11-17T07:09:55.01892+00:00",
                        "updated_at": "2025-11-17T07:09:55.028684+00:00"
                      },
                      "kind": "Invitation",
                      "id": "i-exampleinv03",
                      "email": "user7@example.com",
                      "auth_type": "AUTH_TYPE_SSO",
                      "status": "INVITE_STATUS_ACCEPTED",
                      "accepted_at": "2025-11-17T07:13:01.863287+00:00",
                      "expires_at": "2025-11-20T07:09:55.028684+00:00"
                    }, {
                      "metadata": {
                        "self": "https://api.example.confluent.io/iam/v2/invitations/i-exampleinv01",
                        "resource_name": "crn://example.confluent.io/organization=00000000-0000-0000-0000-000000000000/invitation=i-exampleinv01",
                        "created_at": "2025-11-17T07:14:32.58968+00:00",
                        "updated_at": "2025-11-17T07:14:32.599239+00:00"
                      },
                      "kind": "Invitation",
                      "id": "i-exampleinv01",
                      "email": "user1@example.com",
                      "auth_type": "AUTH_TYPE_SSO",
                      "status": "INVITE_STATUS_ACCEPTED",
                      "accepted_at": "2025-11-17T07:14:56.660743+00:00",
                      "expires_at": "2025-11-20T07:14:32.599239+00:00"
                    }…}
Kind              : InvitationList
MetadataFirst     :
MetadataLast      :
MetadataNext      : https://api.example.confluent.io/iam/v2/invitations?page_token=<TOKEN>
MetadataPrev      :
MetadataTotalSize : 0

This command lists all Invitations under a organization and resource group

Parameters

-Body

List Access Request Model

Parameter properties

Type:Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IListAccessRequestModel
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
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

-JsonFilePath

Path of Json file supplied to the List operation

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ListViaJsonFilePath
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 List operation

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ListViaJsonString
Position:Named
Mandatory:True
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

(All)
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

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SearchFilter

Search filters for the request

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ListExpanded
Position:Named
Mandatory:False
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

(All)
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.

Inputs

Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IListAccessRequestModel

Outputs

Microsoft.Azure.PowerShell.Cmdlets.confluent.Models.IAccessListInvitationsSuccessResponse