Skip to content

Latest commit

 

History

History
227 lines (154 loc) · 9.35 KB

TrustAPIsDAAS.md

File metadata and controls

227 lines (154 loc) · 9.35 KB
Raw

\TrustAPIsDAAS

All URIs are relative to http://localhost

Method HTTP request Description
TrustExchangeToken Post /tokens Exchange the FMA token by using the domain credential. Basic authentication required for current Web Api.
TrustGetBearerTokenWithWindowsAuthentication Get /tokens Exchange the FMA token via Windows Authentication. Kerberos or NTLM authentication required for current Web Api.
TrustRefreshToken Post /tokens/$refresh Refresh the auth token.

TrustExchangeToken

AuthTokenResponseModel TrustExchangeToken(ctx).CitrixCustomerId(citrixCustomerId).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute()

Exchange the FMA token by using the domain credential. Basic authentication required for current Web Api.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration"
)

func main() {
    citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises'
    authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional)
    citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional)
    accept := "application/json" // string | Must accept application/json. (optional)
    citrixLocale := "en-US" // string | Locale of the request. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TrustAPIsDAAS.TrustExchangeToken(context.Background()).CitrixCustomerId(citrixCustomerId).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TrustAPIsDAAS.TrustExchangeToken``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `TrustExchangeToken`: AuthTokenResponseModel
    fmt.Fprintf(os.Stdout, "Response from `TrustAPIsDAAS.TrustExchangeToken`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
citrixCustomerId string Citrix Customer ID. Default is 'CitrixOnPremises'
authorization string Citrix authorization header: CWSAuth Bearer={token}
citrixTransactionId string Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.
accept string Must accept application/json.
citrixLocale string Locale of the request.

Return type

AuthTokenResponseModel

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]

TrustGetBearerTokenWithWindowsAuthentication

AuthTokenResponseModel TrustGetBearerTokenWithWindowsAuthentication(ctx).CitrixCustomerId(citrixCustomerId).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute()

Exchange the FMA token via Windows Authentication. Kerberos or NTLM authentication required for current Web Api.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration"
)

func main() {
    citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises'
    authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional)
    citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional)
    accept := "application/json" // string | Must accept application/json. (optional)
    citrixLocale := "en-US" // string | Locale of the request. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TrustAPIsDAAS.TrustGetBearerTokenWithWindowsAuthentication(context.Background()).CitrixCustomerId(citrixCustomerId).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TrustAPIsDAAS.TrustGetBearerTokenWithWindowsAuthentication``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `TrustGetBearerTokenWithWindowsAuthentication`: AuthTokenResponseModel
    fmt.Fprintf(os.Stdout, "Response from `TrustAPIsDAAS.TrustGetBearerTokenWithWindowsAuthentication`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
citrixCustomerId string Citrix Customer ID. Default is 'CitrixOnPremises'
authorization string Citrix authorization header: CWSAuth Bearer={token}
citrixTransactionId string Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.
accept string Must accept application/json.
citrixLocale string Locale of the request.

Return type

AuthTokenResponseModel

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]

TrustRefreshToken

AuthTokenResponseModel TrustRefreshToken(ctx).CitrixCustomerId(citrixCustomerId).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute()

Refresh the auth token.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration"
)

func main() {
    citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises'
    authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional)
    citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional)
    accept := "application/json" // string | Must accept application/json. (optional)
    citrixLocale := "en-US" // string | Locale of the request. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TrustAPIsDAAS.TrustRefreshToken(context.Background()).CitrixCustomerId(citrixCustomerId).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TrustAPIsDAAS.TrustRefreshToken``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `TrustRefreshToken`: AuthTokenResponseModel
    fmt.Fprintf(os.Stdout, "Response from `TrustAPIsDAAS.TrustRefreshToken`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
citrixCustomerId string Citrix Customer ID. Default is 'CitrixOnPremises'
authorization string Citrix authorization header: CWSAuth Bearer={token}
citrixTransactionId string Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned.
accept string Must accept application/json.
citrixLocale string Locale of the request.

Return type

AuthTokenResponseModel

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]