Edit

Get-AzConfluentAccessUser

  • 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 users details

Syntax

ListExpanded (Default) 

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

List 

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

ListViaJsonFilePath 

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

ListViaJsonString 

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

Description

Organization users details

Examples

Example 1: Get Organization User Details

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

Data              : {{
                      "metadata": {
                        "self": "https://api.example.confluent.io/iam/v2/users/u-exampleuser01",
                        "resource_name": "crn://example.confluent.io/user=u-exampleuser01",
                        "created_at": "2023-05-02T14:34:49.388906+00:00",
                        "updated_at": "2025-12-18T11:54:28.13479+00:00"
                      },
                      "kind": "User",
                      "id": "u-exampleuser01",
                      "email": "user2@example.com",
                      "full_name": "Test User1",
                      "auth_type": "AUTH_TYPE_SSO"
                    }, {
                      "metadata": {
                        "self": "https://api.example.confluent.io/iam/v2/users/u-exampleuser04",
                        "resource_name": "crn://example.confluent.io/user=u-exampleuser04",
                        "created_at": "2025-06-13T08:32:29.093404+00:00",
                        "updated_at": "2025-12-29T09:05:56.451147+00:00"
                      },
                      "kind": "User",
                      "id": "u-exampleuser04",
                      "email": "user3@example.com",
                      "full_name": "Test User2",
                      "auth_type": "AUTH_TYPE_SSO"
                    }, {
                      "metadata": {
                        "self": "https://api.example.confluent.io/iam/v2/users/u-exampleuser03",
                        "resource_name": "crn://example.confluent.io/user=u-exampleuser03",
                        "created_at": "2025-07-23T12:14:02.59428+00:00",
                        "updated_at": "2025-11-20T05:44:51.139779+00:00"
                      },
                      "kind": "User",
                      "id": "u-exampleuser03",
                      "email": "user4@example.com",
                      "full_name": "Pola Shekar",
                      "auth_type": "AUTH_TYPE_SSO"
                    }, {
                      "metadata": {
                        "self": "https://api.example.confluent.io/iam/v2/users/u-exampleuser02",
                        "resource_name": "crn://example.confluent.io/user=u-exampleuser02",
                        "created_at": "2025-09-25T09:15:10.758686+00:00",
                        "updated_at": "2025-11-17T07:20:35.154717+00:00"
                      },
                      "kind": "User",
                      "id": "u-exampleuser02",
                      "email": "user1@example.com",
                      "full_name": "Avish Porwal",
                      "auth_type": "AUTH_TYPE_SSO"
                    }…}
Kind              : UserList
MetadataFirst     :
MetadataLast      :
MetadataNext      : https://api.example.confluent.io/iam/v2/users?page_token=<TOKEN>
MetadataPrev      :
MetadataTotalSize : 0

This command list all Users under an organization in the 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.IAccessListUsersSuccessResponse