TokensApi
All URIs are relative to https://api.ionos.com/auth/v1
TokensDeleteByCriteria
var result DeleteResponse = TokensDeleteByCriteria(ctx)
.Criteria(criteria)
.XContractNumber(xContractNumber)
.Execute()
Delete tokens by criteria
Example
package main
import (
"context"
"fmt"
"os"
auth "github.com/ionos-cloud/sdk-go-bundle/products/auth"
"github.com/ionos-cloud/sdk-go-bundle/shared"
)
func main() {
criteria := "criteria_example" // string | Delete tokens by criteria EXPIRED, ALL, or CURRENT. The tokens are deleted for the specified contract.
xContractNumber := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which the token is generated. (optional)
configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
apiClient := auth.NewAPIClient(configuration)
resource, resp, err := apiClient.TokensApi.TokensDeleteByCriteria(context.Background()).Criteria(criteria).XContractNumber(xContractNumber).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TokensApi.TokensDeleteByCriteria``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
}
// response from `TokensDeleteByCriteria`: DeleteResponse
fmt.Fprintf(os.Stdout, "Response from `TokensApi.TokensDeleteByCriteria`: %v\n", resource)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to an apiTokensDeleteByCriteriaRequest struct via the builder pattern
criteria
string
Delete tokens by criteria EXPIRED, ALL, or CURRENT. The tokens are deleted for the specified contract.
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which the token is generated.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
TokensDeleteById
var result DeleteResponse = TokensDeleteById(ctx, tokenId)
.XContractNumber(xContractNumber)
.Execute()
Delete tokens
Example
package main
import (
"context"
"fmt"
"os"
auth "github.com/ionos-cloud/sdk-go-bundle/products/auth"
"github.com/ionos-cloud/sdk-go-bundle/shared"
)
func main() {
tokenId := "tokenId_example" // string | The Key ID of the token (can be retrieved from the header section of the token).
xContractNumber := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which the token is generated. (optional)
configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
apiClient := auth.NewAPIClient(configuration)
resource, resp, err := apiClient.TokensApi.TokensDeleteById(context.Background(), tokenId).XContractNumber(xContractNumber).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TokensApi.TokensDeleteById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
}
// response from `TokensDeleteById`: DeleteResponse
fmt.Fprintf(os.Stdout, "Response from `TokensApi.TokensDeleteById`: %v\n", resource)
}
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
tokenId
string
The Key ID of the token (can be retrieved from the header section of the token).
Other Parameters
Other parameters are passed through a pointer to an apiTokensDeleteByIdRequest struct via the builder pattern
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which the token is generated.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
TokensFindById
var result Token = TokensFindById(ctx, tokenId)
.XContractNumber(xContractNumber)
.Execute()
Get tokens by Key ID
Example
package main
import (
"context"
"fmt"
"os"
auth "github.com/ionos-cloud/sdk-go-bundle/products/auth"
"github.com/ionos-cloud/sdk-go-bundle/shared"
)
func main() {
tokenId := "tokenId_example" // string | The Key ID of the token (can be retrieved from the header section of the token).
xContractNumber := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which the token is generated. (optional)
configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
apiClient := auth.NewAPIClient(configuration)
resource, resp, err := apiClient.TokensApi.TokensFindById(context.Background(), tokenId).XContractNumber(xContractNumber).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TokensApi.TokensFindById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
}
// response from `TokensFindById`: Token
fmt.Fprintf(os.Stdout, "Response from `TokensApi.TokensFindById`: %v\n", resource)
}
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
tokenId
string
The Key ID of the token (can be retrieved from the header section of the token).
Other Parameters
Other parameters are passed through a pointer to an apiTokensFindByIdRequest struct via the builder pattern
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which the token is generated.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
TokensGenerate
var result Jwt = TokensGenerate(ctx)
.XContractNumber(xContractNumber)
.Execute()
Create new tokens
Example
package main
import (
"context"
"fmt"
"os"
auth "github.com/ionos-cloud/sdk-go-bundle/products/auth"
"github.com/ionos-cloud/sdk-go-bundle/shared"
)
func main() {
xContractNumber := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which the token is generated. (optional)
configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
apiClient := auth.NewAPIClient(configuration)
resource, resp, err := apiClient.TokensApi.TokensGenerate(context.Background()).XContractNumber(xContractNumber).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TokensApi.TokensGenerate``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
}
// response from `TokensGenerate`: Jwt
fmt.Fprintf(os.Stdout, "Response from `TokensApi.TokensGenerate`: %v\n", resource)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to an apiTokensGenerateRequest struct via the builder pattern
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which the token is generated.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
TokensGet
var result Tokens = TokensGet(ctx)
.XContractNumber(xContractNumber)
.Execute()
List all tokens
Example
package main
import (
"context"
"fmt"
"os"
auth "github.com/ionos-cloud/sdk-go-bundle/products/auth"
"github.com/ionos-cloud/sdk-go-bundle/shared"
)
func main() {
xContractNumber := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which the token is generated. (optional)
configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
apiClient := auth.NewAPIClient(configuration)
resource, resp, err := apiClient.TokensApi.TokensGet(context.Background()).XContractNumber(xContractNumber).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `TokensApi.TokensGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
}
// response from `TokensGet`: Tokens
fmt.Fprintf(os.Stdout, "Response from `TokensApi.TokensGet`: %v\n", resource)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to an apiTokensGetRequest struct via the builder pattern
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which the token is generated.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
Last updated