< Back
Connect-Okta
Post
NAME Connect-Okta
SYNOPSIS
Create a connection to your Okta org.
SYNTAX
Connect-Okta [-OktaDomain] <String> [-ApiToken] <String> [<CommonParameters>]
DESCRIPTION
Creates a persistent connection to your Okta org. This connection will persist as long as your PowerShell is open
or until you remove or re-import the Okta module, or until you run the Disconnect-Okta command.
PARAMETERS
-ApiToken <String>
Your Okta API token. This token can be generated in the Okta admin console, and should be protected as a
privileged credential. Be aware that API permissions for the token are the same as the permissions for the
user who created the token.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OktaDomain <String>
The full URL of your Okta org. This must use the "https://" prefix.
Required? true
Position? 0
Default value None
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
None
OUTPUTS
Okta.Sdk.Configuration.OktaClientConfiguration
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Connect-Okta -OktaDomain https://myorg.okta.com -ApiToken "00wc414Z6FMkJyLnXTPfQTl3JpeiFniYa8j4avjVPe"
This example demonstrates connecting to an Okta org "MyOrg."
RELATED LINKS
API Tokens https://developer.okta.com/docs/guides/ ... /overview/
SYNOPSIS
Create a connection to your Okta org.
SYNTAX
Connect-Okta [-OktaDomain] <String> [-ApiToken] <String> [<CommonParameters>]
DESCRIPTION
Creates a persistent connection to your Okta org. This connection will persist as long as your PowerShell is open
or until you remove or re-import the Okta module, or until you run the Disconnect-Okta command.
PARAMETERS
-ApiToken <String>
Your Okta API token. This token can be generated in the Okta admin console, and should be protected as a
privileged credential. Be aware that API permissions for the token are the same as the permissions for the
user who created the token.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OktaDomain <String>
The full URL of your Okta org. This must use the "https://" prefix.
Required? true
Position? 0
Default value None
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
None
OUTPUTS
Okta.Sdk.Configuration.OktaClientConfiguration
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Connect-Okta -OktaDomain https://myorg.okta.com -ApiToken "00wc414Z6FMkJyLnXTPfQTl3JpeiFniYa8j4avjVPe"
This example demonstrates connecting to an Okta org "MyOrg."
RELATED LINKS
API Tokens https://developer.okta.com/docs/guides/ ... /overview/