Okta.PowerShell.Okta.PowerShell\Api.OktaLogStreamApi

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

Method	HTTP request	Description
Invoke-OktaActivateLogStream	POST /api/v1/logStreams/{logStreamId}/lifecycle/activate	Activate a Log Stream
New-OktaLogStream	POST /api/v1/logStreams	Create a Log Stream
Invoke-OktaDeactivateLogStream	POST /api/v1/logStreams/{logStreamId}/lifecycle/deactivate	Deactivate a Log Stream
Invoke-OktaDeleteLogStream	DELETE /api/v1/logStreams/{logStreamId}	Delete a Log Stream
Get-OktaLogStream	GET /api/v1/logStreams/{logStreamId}	Retrieve a Log Stream
Invoke-OktaListLogStreams	GET /api/v1/logStreams	List all Log Streams
Invoke-OktaReplaceLogStream	PUT /api/v1/logStreams/{logStreamId}	Replace a Log Stream

Invoke-OktaActivateLogStream

LogStream Invoke-OktaActivateLogStream
[-LogStreamId]

Activate a Log Stream

Activates a log stream by logStreamId

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

$LogStreamId = "abcd1234" # String | id of the log stream

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

Parameters

Name	Type	Description	Notes
LogStreamId	String	id of the log stream

Return type

LogStream (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-OktaLogStream

LogStream New-OktaLogStream
[-Instance]

Create a Log Stream

Creates a new log stream

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

$HrefObjectHints = Initialize-HrefObjectHints -Allow "DELETE"
$HrefObject = Initialize-HrefObject -Hints $HrefObjectHints -Href "MyHref" -Name "MyName" -Type "MyType"

$LogStreamLinks = Initialize-LogStreamLinks -Self $HrefObject -Activate $HrefObject -Deactivate $HrefObject

$LogStream = Initialize-LogStream -Created (Get-Date) -Id "MyId" -LastUpdated (Get-Date) -Name "MyName" -Status "ACTIVE" -Type "aws_eventbridge" -Links $LogStreamLinks # LogStream | 

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

Parameters

Name	Type	Description	Notes
Instance	LogStream

Return type

LogStream (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-OktaDeactivateLogStream

LogStream Invoke-OktaDeactivateLogStream
[-LogStreamId]

Deactivate a Log Stream

Deactivates a log stream by logStreamId

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

$LogStreamId = "abcd1234" # String | id of the log stream

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

Parameters

Name	Type	Description	Notes
LogStreamId	String	id of the log stream

Return type

LogStream (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-OktaDeleteLogStream

void Invoke-OktaDeleteLogStream
[-LogStreamId]

Delete a Log Stream

Deletes a log stream by logStreamId

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

$LogStreamId = "abcd1234" # String | id of the log stream

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

Parameters

Name	Type	Description	Notes
LogStreamId	String	id of the log stream

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-OktaLogStream

LogStream Get-OktaLogStream
[-LogStreamId]

Retrieve a Log Stream

Retrieve a log stream by logStreamId

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

$LogStreamId = "abcd1234" # String | id of the log stream

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

Parameters

Name	Type	Description	Notes
LogStreamId	String	id of the log stream

Return type

LogStream (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-OktaListLogStreams

LogStream[] Invoke-OktaListLogStreams
        [-After]
        [-Limit] <System.Nullable[Int32]>
        [-Filter]

List all Log Streams

Lists all log streams. You can request a paginated list or a subset of Log Streams that match a supported filter expression.

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

$After = "MyAfter" # String | The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)
$Limit = 56 # Int32 | A limit on the number of objects to return. (optional) (default to 20)
$Filter = "type eq "aws_eventbridge"" # String | SCIM filter expression that filters the results. This expression only supports the `eq` operator on either the `status` or `type`. (optional)

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

Parameters

Name	Type	Description	Notes
After	String	The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See Pagination for more information.	[optional]
Limit	Int32	A limit on the number of objects to return.	[optional] [default to 20]
Filter	String	SCIM filter expression that filters the results. This expression only supports the `eq` operator on either the `status` or `type`.	[optional]

Return type

LogStream[] (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-OktaReplaceLogStream

LogStream Invoke-OktaReplaceLogStream
[-LogStreamId]
[-Instance]

Replace a Log Stream

Replaces a log stream by logStreamId

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

$LogStreamId = "abcd1234" # String | id of the log stream
$HrefObjectHints = Initialize-HrefObjectHints -Allow "DELETE"
$HrefObject = Initialize-HrefObject -Hints $HrefObjectHints -Href "MyHref" -Name "MyName" -Type "MyType"

$LogStreamLinks = Initialize-LogStreamLinks -Self $HrefObject -Activate $HrefObject -Deactivate $HrefObject

$LogStream = Initialize-LogStream -Created (Get-Date) -Id "MyId" -LastUpdated (Get-Date) -Name "MyName" -Status "ACTIVE" -Type "aws_eventbridge" -Links $LogStreamLinks # LogStream | 

# Replace a Log Stream
try {
    $Result = Invoke-OktaReplaceLogStream -LogStreamId $LogStreamId -Instance $Instance
} catch {
    Write-Host ("Exception occurred when calling Invoke-OktaReplaceLogStream: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
LogStreamId	String	id of the log stream
Instance	LogStream

Return type

LogStream (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]

Files

OktaLogStreamApi.md

Latest commit

History

OktaLogStreamApi.md

File metadata and controls

Okta.PowerShell.Okta.PowerShell\Api.OktaLogStreamApi

Invoke-OktaActivateLogStream

Example

Parameters

Return type

Authorization

HTTP request headers

New-OktaLogStream

Example

Parameters

Return type

Authorization

HTTP request headers

Invoke-OktaDeactivateLogStream

Example

Parameters

Return type

Authorization

HTTP request headers

Invoke-OktaDeleteLogStream

Example

Parameters

Return type

Authorization

HTTP request headers

Get-OktaLogStream

Example

Parameters

Return type

Authorization

HTTP request headers

Invoke-OktaListLogStreams

Example

Parameters

Return type

Authorization

HTTP request headers

Invoke-OktaReplaceLogStream

Example

Parameters

Return type

Authorization

HTTP request headers