Skip to content

Latest commit

 

History

History
379 lines (263 loc) · 13 KB

OktaTrustedOriginApi.md

File metadata and controls

379 lines (263 loc) · 13 KB
Raw

Okta.PowerShell.Okta.PowerShell\Api.OktaTrustedOriginApi

All URIs are relative to https://subdomain.okta.com

Method HTTP request Description
Invoke-OktaActivateOrigin POST /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/activate Activate a Trusted Origin
New-OktaOrigin POST /api/v1/trustedOrigins Create a Trusted Origin
Invoke-OktaDeactivateOrigin POST /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/deactivate Deactivate a Trusted Origin
Invoke-OktaDeleteOrigin DELETE /api/v1/trustedOrigins/{trustedOriginId} Delete a Trusted Origin
Get-OktaOrigin GET /api/v1/trustedOrigins/{trustedOriginId} Retrieve a Trusted Origin
Invoke-OktaListOrigins GET /api/v1/trustedOrigins List all Trusted Origins
Update-OktaOrigin PUT /api/v1/trustedOrigins/{trustedOriginId} Replace a Trusted Origin

Invoke-OktaActivateOrigin

TrustedOrigin Invoke-OktaActivateOrigin
        [-TrustedOriginId]

Activate a Trusted Origin

Activate a trusted origin

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$TrustedOriginId = "MyTrustedOriginId" # String | 

# Activate a Trusted Origin
try {
    $Result = Invoke-OktaActivateOrigin -TrustedOriginId $TrustedOriginId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaActivateOrigin: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
TrustedOriginId String

Return type

TrustedOrigin (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

New-OktaOrigin

TrustedOrigin New-OktaOrigin
        [-TrustedOrigin]

Create a Trusted Origin

Create a trusted origin

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$TrustedOriginScope = Initialize-TrustedOriginScope -AllowedOktaApps "OKTA_ENDUSER" -Type "CORS"
$TrustedOrigin = Initialize-TrustedOrigin -Created (Get-Date) -CreatedBy "MyCreatedBy" -Id "MyId" -LastUpdated (Get-Date) -LastUpdatedBy "MyLastUpdatedBy" -Name "MyName" -Origin "MyOrigin" -Scopes $TrustedOriginScope -Status "MyStatus" -Links @{ key_example =  } # TrustedOrigin | 

# Create a Trusted Origin
try {
    $Result = New-OktaOrigin -TrustedOrigin $TrustedOrigin
} catch {
    Write-Host ("Exception occurred when calling New-OktaOrigin: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
TrustedOrigin TrustedOrigin

Return type

TrustedOrigin (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaDeactivateOrigin

TrustedOrigin Invoke-OktaDeactivateOrigin
        [-TrustedOriginId]

Deactivate a Trusted Origin

Deactivate a trusted origin

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$TrustedOriginId = "MyTrustedOriginId" # String | 

# Deactivate a Trusted Origin
try {
    $Result = Invoke-OktaDeactivateOrigin -TrustedOriginId $TrustedOriginId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaDeactivateOrigin: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
TrustedOriginId String

Return type

TrustedOrigin (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaDeleteOrigin

void Invoke-OktaDeleteOrigin
        [-TrustedOriginId]

Delete a Trusted Origin

Delete a trusted origin

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$TrustedOriginId = "MyTrustedOriginId" # String | 

# Delete a Trusted Origin
try {
    $Result = Invoke-OktaDeleteOrigin -TrustedOriginId $TrustedOriginId
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaDeleteOrigin: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
TrustedOriginId String

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get-OktaOrigin

TrustedOrigin Get-OktaOrigin
        [-TrustedOriginId]

Retrieve a Trusted Origin

Retrieve a trusted origin

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$TrustedOriginId = "MyTrustedOriginId" # String | 

# Retrieve a Trusted Origin
try {
    $Result = Get-OktaOrigin -TrustedOriginId $TrustedOriginId
} catch {
    Write-Host ("Exception occurred when calling Get-OktaOrigin: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
TrustedOriginId String

Return type

TrustedOrigin (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-OktaListOrigins

TrustedOrigin[] Invoke-OktaListOrigins
        [-Q]
        [-Filter]
        [-After]
        [-Limit] <System.Nullable[Int32]>

List all Trusted Origins

List all trusted origins

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$Q = "MyQ" # String |  (optional)
$Filter = "MyFilter" # String |  (optional)
$After = "MyAfter" # String |  (optional)
$Limit = 56 # Int32 |  (optional) (default to -1)

# List all Trusted Origins
try {
    $Result = Invoke-OktaListOrigins -Q $Q -Filter $Filter -After $After -Limit $Limit
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaListOrigins: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Q String [optional]
Filter String [optional]
After String [optional]
Limit Int32 [optional] [default to -1]

Return type

TrustedOrigin[] (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Update-OktaOrigin

TrustedOrigin Update-OktaOrigin
        [-TrustedOriginId]
        [-TrustedOrigin]

Replace a Trusted Origin

Replace a trusted origin

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-OktaConfiguration

# Configure your client ID and scope for authorization
$Configuration.ClientId = "YOUR_CLIENT_ID"
$Configuration.Scope = "OKTA_SCOPES" # for example okta.users.read

$TrustedOriginId = "MyTrustedOriginId" # String | 
$TrustedOriginScope = Initialize-TrustedOriginScope -AllowedOktaApps "OKTA_ENDUSER" -Type "CORS"
$TrustedOrigin = Initialize-TrustedOrigin -Created (Get-Date) -CreatedBy "MyCreatedBy" -Id "MyId" -LastUpdated (Get-Date) -LastUpdatedBy "MyLastUpdatedBy" -Name "MyName" -Origin "MyOrigin" -Scopes $TrustedOriginScope -Status "MyStatus" -Links @{ key_example =  } # TrustedOrigin | 

# Replace a Trusted Origin
try {
    $Result = Update-OktaOrigin -TrustedOriginId $TrustedOriginId -TrustedOrigin $TrustedOrigin
} catch {
    Write-Host ("Exception occurred when calling Update-OktaOrigin: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
TrustedOriginId String
TrustedOrigin TrustedOrigin

Return type

TrustedOrigin (PSCustomObject)

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]