< Back

Get-EdgeNewAdminToken

Sun Jan 19, 2020 6:03 pm

NAME Get-EdgeNewAdminToken



SYNOPSIS

Gets an OAuth token for Edge Administration.





SYNTAX

Get-EdgeNewAdminToken [[-SsoOneTimePasscode] <String>] [[-SsoZone] <String>] [[-SsoUrl] <String>] [[-MfaCode]

<String>] [<CommonParameters>]





DESCRIPTION

Gets an OAuth token for Edge Administration. This works only with Edge SaaS.

You must have previously called Set-EdgeConnection to specify the user + password.

In fact this cmdlet gets called implicitly by Set-EdgeConnection as necessary.

You probably do not need to call it directly.





PARAMETERS

-SsoOneTimePasscode <String>

Optional. The one-time passcode for authenticating, obtained from the https://ZONE.login.apigee.com/passcode

endpoint.

This is applicable only when using SAML-based SSO for login to Apigee Edge.



Required? false

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-SsoZone <String>

Optional. The SSO Zone for your user. By default there is no zone. This value will affect the SSO Login URL.

If you pass in "zone1" then the login url will become https://zone1.login.apigee.com/ . If you would like

to explicitly specify the SSO URL, then omit this parameter and set the SsoUrl parameter.

Specify at most one of SsoZone and SsoUrl.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-SsoUrl <String>

Optional. This defaults to 'https://login.apigee.com'. If you are using SAML Sign in, then specify

https://YOURZONE.login.apigee.com/ for this parameter. Specify at most one of SsoZone and SsoUrl.



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-MfaCode <String>

Optional. The MFA code for authenticating, if your user requires it.



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS





RELATED LINKS

Set-EdgeConnection

Get-EdgeStashedAdminToken

Get-EdgeRefreshedAdminToken