Skip to content

DomainAuthProviderAPI.md

Latest commit

 

History

History
292 lines (190 loc) · 9.08 KB

DomainAuthProviderAPI.md

File metadata and controls

292 lines (190 loc) · 9.08 KB
Raw

\DomainAuthProviderAPI

All URIs are relative to https://app.corellium.com/api

Method HTTP request Description
V1CreateDomainAuthProvider Post /v1/domain/{domainId}/auth Create a new auth provider for a domain
V1DeleteDomainAuthProvider Delete /v1/domain/{domainId}/auth/{providerId} Delete an auth provider from a domain
V1GetDomainAuthProviders Get /v1/domain/{domainId}/auth Return all configured auth providers for a domain (including globally configured providers)
V1UpdateDomainAuthProvider Put /v1/domain/{domainId}/auth/{providerId} Update an auth provider for a domain

V1CreateDomainAuthProvider

DomainAuthProviderResponseV1 V1CreateDomainAuthProvider(ctx, domainId).DomainAuthProviderRequest(domainAuthProviderRequest).Execute()

Create a new auth provider for a domain

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/corellium/corellium-go-api-client"
)

func main() {
	domainId := "domainId_example" // string | Domain ID - uuid
	domainAuthProviderRequest := *openapiclient.NewDomainAuthProviderRequest("ProviderType_example", false) // DomainAuthProviderRequest | Request Data

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
domainId string Domain ID - uuid

Other Parameters

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

Name Type Description Notes

domainAuthProviderRequest | DomainAuthProviderRequest | Request Data |

Return type

DomainAuthProviderResponseV1

Authorization

BearerAuth

HTTP request headers

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

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

V1DeleteDomainAuthProvider

V1DeleteDomainAuthProvider(ctx, domainId, providerId).Execute()

Delete an auth provider from a domain

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/corellium/corellium-go-api-client"
)

func main() {
	domainId := "domainId_example" // string | Domain ID - uuid
	providerId := "providerId_example" // string | Provider ID - uuid

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.DomainAuthProviderAPI.V1DeleteDomainAuthProvider(context.Background(), domainId, providerId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DomainAuthProviderAPI.V1DeleteDomainAuthProvider``: %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.
domainId string Domain ID - uuid
providerId string Provider ID - uuid

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

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

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

V1GetDomainAuthProviders

[]DomainAuthProviderResponseV1 V1GetDomainAuthProviders(ctx, domainId).Execute()

Return all configured auth providers for a domain (including globally configured providers)

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/corellium/corellium-go-api-client"
)

func main() {
	domainId := "domainId_example" // string | Domain ID - uuid

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
domainId string Domain ID - uuid

Other Parameters

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

Name Type Description Notes

Return type

[]DomainAuthProviderResponseV1

Authorization

BearerAuth

HTTP request headers

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

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

V1UpdateDomainAuthProvider

DomainAuthProviderResponseV1 V1UpdateDomainAuthProvider(ctx, domainId, providerId).DomainAuthProviderRequest(domainAuthProviderRequest).Execute()

Update an auth provider for a domain

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/corellium/corellium-go-api-client"
)

func main() {
	domainId := "domainId_example" // string | Domain ID - uuid
	providerId := "providerId_example" // string | Provider ID - uuid
	domainAuthProviderRequest := *openapiclient.NewDomainAuthProviderRequest("ProviderType_example", false) // DomainAuthProviderRequest | Request Data

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DomainAuthProviderAPI.V1UpdateDomainAuthProvider(context.Background(), domainId, providerId).DomainAuthProviderRequest(domainAuthProviderRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DomainAuthProviderAPI.V1UpdateDomainAuthProvider``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `V1UpdateDomainAuthProvider`: DomainAuthProviderResponseV1
	fmt.Fprintf(os.Stdout, "Response from `DomainAuthProviderAPI.V1UpdateDomainAuthProvider`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
domainId string Domain ID - uuid
providerId string Provider ID - uuid

Other Parameters

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

Name Type Description Notes

domainAuthProviderRequest | DomainAuthProviderRequest | Request Data |

Return type

DomainAuthProviderResponseV1

Authorization

BearerAuth

HTTP request headers

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

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