Skip to content

Latest commit

 

History

History
221 lines (140 loc) · 6.28 KB

Identities.md

File metadata and controls

221 lines (140 loc) · 6.28 KB
Raw

\Identities

All URIs are relative to https://pipes.turbot.com/api/v0

Method HTTP request Description
Get Get /identity/{identity_handle} Get identity
GetAvatar Get /identity/{identity_handle}/avatar Get identity avatar
List Get /identity List identities

Get

Identity Get(ctx, identityHandle).Execute()

Get identity

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    identityHandle := "identityHandle_example" // string | Specify the handle of the identity whose information you want to retrieve.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
identityHandle string Specify the handle of the identity whose information you want to retrieve.

Other Parameters

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

Name Type Description Notes

Return type

Identity

Authorization

No authorization required

HTTP request headers

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

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

GetAvatar

WorkspaceSnapshotData GetAvatar(ctx, identityHandle).Execute()

Get identity avatar

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    identityHandle := "identityHandle_example" // string | Specify the handle of the identity whose avatar you want to retrieve.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
identityHandle string Specify the handle of the identity whose avatar you want to retrieve.

Other Parameters

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

Name Type Description Notes

Return type

WorkspaceSnapshotData

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

List

ListIdentitiesResponse List(ctx).Q(q).Limit(limit).NextToken(nextToken).Execute()

List identities

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    q := "q_example" // string | Optional free-text search to filter the identities. (optional)
    limit := int32(56) // int32 | The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. (optional) (default to 25)
    nextToken := "nextToken_example" // string | When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data. (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.Identities.List(context.Background()).Q(q).Limit(limit).NextToken(nextToken).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `Identities.List``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `List`: ListIdentitiesResponse
    fmt.Fprintf(os.Stdout, "Response from `Identities.List`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
q string Optional free-text search to filter the identities.
limit int32 The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25. [default to 25]
nextToken string When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.

Return type

ListIdentitiesResponse

Authorization

No authorization required

HTTP request headers

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

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