Skip to content

Set GAdminSettingsSsoSettings

Spencer Varney edited this page Dec 9, 2016 · 2 revisions

Deprectiation Notice: The Admin Settings API is deprecated and is scheduled to be sunset on August 16, 2017. See the following URL for more information: https://developers.google.com/admin-sdk/admin-settings/

Set-GAdminSettingsSsoSettings

SYNOPSIS

Update the Single Sign-On settings.

SYNTAX

Set-GAdminSettingsSsoSettings [-SamlSignonUri] <String> [-SamlLogoutUri] <String> [-ChangePasswordUri] <String>
 [-EnableSSO] <Boolean> [-SsoWhitelist] <String> [-UseDomainSpecificIssuer] <Boolean> [-Domain <String>]
 [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Update the Single Sign-On settings.

EXAMPLES

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

PS C:\> Set-GAdminSettingsSsoSettings -SamlSignonUri $SomeSamlSignonUriString -SamlLogoutUri $SomeSamlLogoutUriString
                -UseDomainSpecificIssuer $SomeUseDomainSpecificIssuerBool -ChangePasswordUri $SomeChangePasswordUriString -EnableSSO
                $SomeEnableSSOBool -SsoWhitelist $SomeSsoWhitelistString -UseDomainSpecificIssuer $SomeUseDomainSpecificIssuerBool

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

-SamlSignonUri

The identity provider's URL where Google Apps sends the SAML request for user authentication.

Type: String
Parameter Sets: (All)
Aliases: 

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

-SamlLogoutUri

The address that users will be sent to when they log out of the web application.

Type: String
Parameter Sets: (All)
Aliases: 

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

-ChangePasswordUri

The address that users will be sent to when they want to change their SSO password for the web application.

Type: String
Parameter Sets: (All)
Aliases: 

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

-EnableSSO

Enable SAML-based SSO for this domain.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-SsoWhitelist

A network mask IP address in Classless Inter-Domain Routing (CIDR) format.

Type: String
Parameter Sets: (All)
Aliases: 

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

-UseDomainSpecificIssuer

A domain specific issuer used in the SAML request to the identity provider.

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-Domain

The target domain for this admin settings cmdlet.

Type: String
Parameter Sets: (All)
Aliases: 

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

-GAuthId

The GAuthId representing the gShell auth credentials this cmdlet should use to run.

Type: String
Parameter Sets: (All)
Aliases: 

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

INPUTS

System.String

The identity provider's URL where Google Apps sends the SAML request for user authentication.

System.String

The address that users will be sent to when they log out of the web application.

System.String

The address that users will be sent to when they want to change their SSO password for the web application.

System.Boolean

Enable SAML-based SSO for this domain.

System.String

A network mask IP address in Classless Inter-Domain Routing (CIDR) format.

System.Boolean

A domain specific issuer used in the SAML request to the identity provider.

System.String

The target domain for this admin settings cmdlet.

OUTPUTS

NOTES

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

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]

Clone this wiki locally