Skip to content
Spencer Varney edited this page Dec 14, 2016 · 3 revisions

New-GARoleObj

SYNOPSIS

Creates a new Directory API Role object.

SYNTAX

New-GARoleObj [[-IsSuperAdminRole] <Boolean>] [[-IsSystemRole] <Boolean>] [[-RoleDescription] <String>]
 [[-RoleId] <Int64>] [[-RoleName] <String>] [[-RolePrivileges] <RolePrivilegesData[]>] [-WhatIf] [-Confirm]

DESCRIPTION

This provides a Cmdlet-Based approach to creating a Role object which may be required as a parameter for some other Cmdlets in the Directory API category.

You could alternately create this object by calling New-Object -TypeName Google.Apis.admin.Directory.directory_v1.Data.Role

EXAMPLES

---------- EXAMPLE 1 ----------

PS C:\> New-GARoleObj

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

PARAMETERS

-IsSuperAdminRole

Returns true if the role is a super admin role.

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 0
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IsSystemRole

Returns true if this is a pre-defined system role.

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 1
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-RoleDescription

A short description of the role.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 2
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-RoleId

ID of the role.

Type: Int64
Parameter Sets: (All)
Aliases: 

Required: False
Position: 3
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-RoleName

Name of the role.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 4
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-RolePrivileges

The set of privileges that are granted to this role.

Type: RolePrivilegesData[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: 5
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

INPUTS

System.Boolean

Returns true if the role is a super admin role.

System.Boolean

Returns true if this is a pre-defined system role.

System.String

A short description of the role.

System.Int64

ID of the role.

System.String

Name of the role.

Google.Apis.admin.Directory.directory_v1.Data.Role+RolePrivilegesData[]

The set of privileges that are granted to this role.

OUTPUTS

Google.Apis.admin.Directory.directory_v1.Data.Role

NOTES

Part of the gShell Project, relating to the Google Directory API; see Related Links or use the -Online parameter.

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]

Clone this wiki locally