Skip to content

Latest commit

 

History

History
378 lines (241 loc) · 11.2 KB

IdentityPoolsIamV2Api.md

File metadata and controls

378 lines (241 loc) · 11.2 KB
Raw

\IdentityPoolsIamV2Api

All URIs are relative to https://api.confluent.cloud

Method HTTP request Description
CreateIamV2IdentityPool Post /iam/v2/identity-providers/{provider_id}/identity-pools Create an Identity Pool
DeleteIamV2IdentityPool Delete /iam/v2/identity-providers/{provider_id}/identity-pools/{id} Delete an Identity Pool
GetIamV2IdentityPool Get /iam/v2/identity-providers/{provider_id}/identity-pools/{id} Read an Identity Pool
ListIamV2IdentityPools Get /iam/v2/identity-providers/{provider_id}/identity-pools List of Identity Pools
UpdateIamV2IdentityPool Patch /iam/v2/identity-providers/{provider_id}/identity-pools/{id} Update an Identity Pool

CreateIamV2IdentityPool

IamV2IdentityPool CreateIamV2IdentityPool(ctx, providerId).IamV2IdentityPool(iamV2IdentityPool).Execute()

Create an Identity Pool

Example

package main

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

func main() {
    providerId := "providerId_example" // string | The Provider
    iamV2IdentityPool := *openapiclient.NewIamV2IdentityPool() // IamV2IdentityPool |  (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId string The Provider

Other Parameters

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

Name Type Description Notes

iamV2IdentityPool | IamV2IdentityPool | |

Return type

IamV2IdentityPool

Authorization

api-key

HTTP request headers

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

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

DeleteIamV2IdentityPool

DeleteIamV2IdentityPool(ctx, providerId, id).Execute()

Delete an Identity Pool

Example

package main

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

func main() {
    providerId := "providerId_example" // string | The Provider
    id := "id_example" // string | The unique identifier for the identity pool.

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.IdentityPoolsIamV2Api.DeleteIamV2IdentityPool(context.Background(), providerId, id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IdentityPoolsIamV2Api.DeleteIamV2IdentityPool``: %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.
providerId string The Provider
id string The unique identifier for the identity pool.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

api-key

HTTP request headers

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

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

GetIamV2IdentityPool

IamV2IdentityPool GetIamV2IdentityPool(ctx, providerId, id).Execute()

Read an Identity Pool

Example

package main

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

func main() {
    providerId := "providerId_example" // string | The Provider
    id := "id_example" // string | The unique identifier for the identity pool.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId string The Provider
id string The unique identifier for the identity pool.

Other Parameters

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

Name Type Description Notes

Return type

IamV2IdentityPool

Authorization

api-key

HTTP request headers

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

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

ListIamV2IdentityPools

IamV2IdentityPoolList ListIamV2IdentityPools(ctx, providerId).PageSize(pageSize).PageToken(pageToken).Execute()

List of Identity Pools

Example

package main

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

func main() {
    providerId := "providerId_example" // string | The Provider
    pageSize := int32(56) // int32 | A pagination size for collection requests. (optional) (default to 10)
    pageToken := "pageToken_example" // string | An opaque pagination token for collection requests. (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.IdentityPoolsIamV2Api.ListIamV2IdentityPools(context.Background(), providerId).PageSize(pageSize).PageToken(pageToken).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IdentityPoolsIamV2Api.ListIamV2IdentityPools``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListIamV2IdentityPools`: IamV2IdentityPoolList
    fmt.Fprintf(os.Stdout, "Response from `IdentityPoolsIamV2Api.ListIamV2IdentityPools`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId string The Provider

Other Parameters

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

Name Type Description Notes

pageSize | int32 | A pagination size for collection requests. | [default to 10] pageToken | string | An opaque pagination token for collection requests. |

Return type

IamV2IdentityPoolList

Authorization

api-key

HTTP request headers

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

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

UpdateIamV2IdentityPool

IamV2IdentityPool UpdateIamV2IdentityPool(ctx, providerId, id).IamV2IdentityPool(iamV2IdentityPool).Execute()

Update an Identity Pool

Example

package main

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

func main() {
    providerId := "providerId_example" // string | The Provider
    id := "id_example" // string | The unique identifier for the identity pool.
    iamV2IdentityPool := *openapiclient.NewIamV2IdentityPool() // IamV2IdentityPool |  (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
providerId string The Provider
id string The unique identifier for the identity pool.

Other Parameters

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

Name Type Description Notes

iamV2IdentityPool | IamV2IdentityPool | |

Return type

IamV2IdentityPool

Authorization

api-key

HTTP request headers

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

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