Skip to content

Read-VerkadaAccessUsers.md

Latest commit

 

History

History
252 lines (197 loc) · 6.3 KB

Read-VerkadaAccessUsers.md

File metadata and controls

252 lines (197 loc) · 6.3 KB
external help file verkadaModule-help.xml
Module Name verkadaModule
online version https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Read-VerkadaAccessUsers.md
schema 2.0.0

Read-VerkadaAccessUsers

SYNOPSIS

Gathers all Access Users in an organization via the legacy private API or using https://apidocs.verkada.com/reference/getaccessmembersviewv1 depedning on the version of the function specified.

SYNTAX

v1 (Default)

Read-VerkadaAccessUsers [-x_verkada_auth_api <String>] [-region <String>] [-refresh] [-version <String>]
 [-errorsToFile] [-ProgressAction <ActionPreference>] [<CommonParameters>]

legacy

Read-VerkadaAccessUsers [[-query] <Object>] [[-variables] <Object>] [-region <String>]
 [-x_verkada_token <String>] [-x_verkada_auth <String>] [-usr <String>] [-refresh] [-minimal]
 [-version <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

This function will return all the active Access users in an organization. The org_id and reqired tokens can be directly submitted as parameters, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands.

EXAMPLES

EXAMPLE 1

Read-VerkadaAccessUsers
This will return all the active access users in an organization.	The token will be populated from the cache created by Connect-Verkada.

EXAMPLE 2

Read-VerkadaAccessUsers -userId 'aefrfefb-3429-39ec-b042-userAC' -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_verkada_token 'a366ef47-2c20-4d35-a90a-10fd2aee113a' -x_verkada_auth 'auth-token-uuid-dscsdc' -usr 'a099bfe6-34ff-4976-9d53-ac68342d2b60'
This will return all the active access users in an organization.  The token is submitted as a parameter in the call.

EXAMPLE 3

Read-VerkadaAccessUsers -version v1 -x_verkada_auth_api 'v2_sd78d9verkada-token'
This will return all the active access users in an organization using the Command v1 public API endpoint.  The token is submitted as a parameter in the call.

EXAMPLE 4

Read-VerkadaAccessUsers -version v1 -refresh
This will return all the active access users in an organization with the most recent data available from the Command v1 public API endpoint.  The token will be populated from the cache created by Connect-Verkada.

PARAMETERS

-query

This is the graphql query to be submitted (do not use unless you know what you are doing)

Type: Object
Parameter Sets: legacy
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-variables

This is the graphql variables to be submitted (do not use unless you know what you are doing)

Type: Object
Parameter Sets: legacy
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-x_verkada_auth_api

The public API token obatined via the Login endpoint to be used for calls that hit the public API gateway

Type: String
Parameter Sets: v1
Aliases:

Required: False
Position: Named
Default value: $Global:verkadaConnection.x_verkada_auth_api
Accept pipeline input: False
Accept wildcard characters: False

-region

The region of the public API to be used

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Api
Accept pipeline input: False
Accept wildcard characters: False

-x_verkada_token

The Verkada(CSRF) token of the user running the command

Type: String
Parameter Sets: legacy
Aliases:

Required: False
Position: Named
Default value: $Global:verkadaConnection.csrfToken
Accept pipeline input: False
Accept wildcard characters: False

-x_verkada_auth

The Verkada Auth(session auth) token of the user running the command

Type: String
Parameter Sets: legacy
Aliases:

Required: False
Position: Named
Default value: $Global:verkadaConnection.userToken
Accept pipeline input: False
Accept wildcard characters: False

-usr

The UUID of the user account making the request

Type: String
Parameter Sets: legacy
Aliases:

Required: False
Position: Named
Default value: $Global:verkadaConnection.usr
Accept pipeline input: False
Accept wildcard characters: False

-refresh

Switch to force a refreshed list of users from Command

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-minimal

Switch to retrieve the list of users from Command with minimal user profile information

Type: SwitchParameter
Parameter Sets: legacy
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-version

Version designation for which version of the function to use

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Legacy
Accept pipeline input: False
Accept wildcard characters: False

-errorsToFile

Switch to write errors to file

Type: SwitchParameter
Parameter Sets: v1
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Read-VerkadaAccessUsers.md