\LogStreamAPI

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

Method	HTTP request	Description
ActivateLogStream	Post /api/v1/logStreams/{logStreamId}/lifecycle/activate	Activate a Log Stream
CreateLogStream	Post /api/v1/logStreams	Create a Log Stream
DeactivateLogStream	Post /api/v1/logStreams/{logStreamId}/lifecycle/deactivate	Deactivate a Log Stream
DeleteLogStream	Delete /api/v1/logStreams/{logStreamId}	Delete a Log Stream
GetLogStream	Get /api/v1/logStreams/{logStreamId}	Retrieve a Log Stream
ListLogStreams	Get /api/v1/logStreams	List all Log Streams
ReplaceLogStream	Put /api/v1/logStreams/{logStreamId}	Replace a Log Stream

ActivateLogStream

ListLogStreams200ResponseInner ActivateLogStream(ctx, logStreamId).Execute()

Activate a Log Stream

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/okta/okta-sdk-golang"
)

func main() {
    logStreamId := "0oa1orzg0CHSgPcjZ0g4" // string | Unique identifier for the Log Stream

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogStreamAPI.ActivateLogStream(context.Background(), logStreamId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogStreamAPI.ActivateLogStream``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ActivateLogStream`: ListLogStreams200ResponseInner
    fmt.Fprintf(os.Stdout, "Response from `LogStreamAPI.ActivateLogStream`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
logStreamId	string	Unique identifier for the Log Stream

Other Parameters

Other parameters are passed through a pointer to a apiActivateLogStreamRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ListLogStreams200ResponseInner

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]

CreateLogStream

ListLogStreams200ResponseInner CreateLogStream(ctx).Instance(instance).Execute()

Create a Log Stream

Example

package main

import (
    "context"
    "fmt"
    "os"
    "time"
    openapiclient "github.com/okta/okta-sdk-golang"
)

func main() {
    instance := openapiclient.listLogStreams_200_response_inner{LogStreamAws: openapiclient.NewLogStreamAws(*openapiclient.NewLogStreamSettingsAws("123456789012", "your-event-source-name", openapiclient.AwsRegion("ap-northeast-1")), time.Now(), "0oa1orzg0CHSgPcjZ0g4", time.Now(), "My AWS EventBridge log stream", "Status_example", openapiclient.LogStreamType("aws_eventbridge"), *openapiclient.NewLogStreamLinksSelfAndLifecycle(*openapiclient.NewLogStreamSelfLink("Href_example")))} // ListLogStreams200ResponseInner | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogStreamAPI.CreateLogStream(context.Background()).Instance(instance).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogStreamAPI.CreateLogStream``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateLogStream`: ListLogStreams200ResponseInner
    fmt.Fprintf(os.Stdout, "Response from `LogStreamAPI.CreateLogStream`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateLogStreamRequest struct via the builder pattern

Name	Type	Description	Notes
instance	ListLogStreams200ResponseInner

Return type

ListLogStreams200ResponseInner

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]

DeactivateLogStream

ListLogStreams200ResponseInner DeactivateLogStream(ctx, logStreamId).Execute()

Deactivate a Log Stream

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/okta/okta-sdk-golang"
)

func main() {
    logStreamId := "0oa1orzg0CHSgPcjZ0g4" // string | Unique identifier for the Log Stream

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogStreamAPI.DeactivateLogStream(context.Background(), logStreamId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogStreamAPI.DeactivateLogStream``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeactivateLogStream`: ListLogStreams200ResponseInner
    fmt.Fprintf(os.Stdout, "Response from `LogStreamAPI.DeactivateLogStream`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
logStreamId	string	Unique identifier for the Log Stream

Other Parameters

Other parameters are passed through a pointer to a apiDeactivateLogStreamRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ListLogStreams200ResponseInner

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]

DeleteLogStream

DeleteLogStream(ctx, logStreamId).Execute()

Delete a Log Stream

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/okta/okta-sdk-golang"
)

func main() {
    logStreamId := "0oa1orzg0CHSgPcjZ0g4" // string | Unique identifier for the Log Stream

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.LogStreamAPI.DeleteLogStream(context.Background(), logStreamId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogStreamAPI.DeleteLogStream``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
logStreamId	string	Unique identifier for the Log Stream

Other Parameters

Other parameters are passed through a pointer to a apiDeleteLogStreamRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

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

GetLogStream

ListLogStreams200ResponseInner GetLogStream(ctx, logStreamId).Execute()

Retrieve a Log Stream

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/okta/okta-sdk-golang"
)

func main() {
    logStreamId := "0oa1orzg0CHSgPcjZ0g4" // string | Unique identifier for the Log Stream

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogStreamAPI.GetLogStream(context.Background(), logStreamId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogStreamAPI.GetLogStream``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLogStream`: ListLogStreams200ResponseInner
    fmt.Fprintf(os.Stdout, "Response from `LogStreamAPI.GetLogStream`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
logStreamId	string	Unique identifier for the Log Stream

Other Parameters

Other parameters are passed through a pointer to a apiGetLogStreamRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ListLogStreams200ResponseInner

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]

ListLogStreams

[]ListLogStreams200ResponseInner ListLogStreams(ctx).After(after).Limit(limit).Filter(filter).Execute()

List all Log Streams

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/okta/okta-sdk-golang"
)

func main() {
    after := "after_example" // 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 := int32(56) // int32 | A limit on the number of objects to return (optional) (default to 20)
    filter := "type eq "aws_eventbridge"" // string | An expression that [filters](/#filter) the returned objects. You can only use the `eq` operator on either the `status` or `type` properties in the filter expression. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogStreamAPI.ListLogStreams(context.Background()).After(after).Limit(limit).Filter(filter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogStreamAPI.ListLogStreams``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListLogStreams`: []ListLogStreams200ResponseInner
    fmt.Fprintf(os.Stdout, "Response from `LogStreamAPI.ListLogStreams`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListLogStreamsRequest struct via the builder pattern

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.
limit	int32	A limit on the number of objects to return	[default to 20]
filter	string	An expression that filters the returned objects. You can only use the `eq` operator on either the `status` or `type` properties in the filter expression.

Return type

[]ListLogStreams200ResponseInner

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]

ReplaceLogStream

ListLogStreams200ResponseInner ReplaceLogStream(ctx, logStreamId).Instance(instance).Execute()

Replace a Log Stream

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/okta/okta-sdk-golang"
)

func main() {
    logStreamId := "0oa1orzg0CHSgPcjZ0g4" // string | Unique identifier for the Log Stream
    instance := openapiclient.replaceLogStream_request{LogStreamAwsPutSchema: openapiclient.NewLogStreamAwsPutSchema(*openapiclient.NewLogStreamSettingsAws("123456789012", "your-event-source-name", openapiclient.AwsRegion("ap-northeast-1")), "My AWS EventBridge log stream", openapiclient.LogStreamType("aws_eventbridge"))} // ReplaceLogStreamRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogStreamAPI.ReplaceLogStream(context.Background(), logStreamId).Instance(instance).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogStreamAPI.ReplaceLogStream``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ReplaceLogStream`: ListLogStreams200ResponseInner
    fmt.Fprintf(os.Stdout, "Response from `LogStreamAPI.ReplaceLogStream`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
logStreamId	string	Unique identifier for the Log Stream

Other Parameters

Other parameters are passed through a pointer to a apiReplaceLogStreamRequest struct via the builder pattern

Name	Type	Description	Notes

instance | ReplaceLogStreamRequest | |

Return type

ListLogStreams200ResponseInner

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

LogStreamAPI.md

Latest commit

History

LogStreamAPI.md

File metadata and controls

\LogStreamAPI

ActivateLogStream

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateLogStream

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeactivateLogStream

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteLogStream

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetLogStream

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListLogStreams

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ReplaceLogStream

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers