Documentation
¶
Index ¶
- type Client
- func (c *Client) Create(ctx context.Context, ...) (*management.CreateTokenExchangeProfileResponseContent, error)
- func (c *Client) Delete(ctx context.Context, id string, opts ...option.RequestOption) error
- func (c *Client) Get(ctx context.Context, id string, opts ...option.RequestOption) (*management.GetTokenExchangeProfileResponseContent, error)
- func (c *Client) List(ctx context.Context, request *management.TokenExchangeProfilesListRequest, ...) (...)
- func (c *Client) Update(ctx context.Context, id string, ...) error
- type RawClient
- func (r *RawClient) Create(ctx context.Context, ...) (*core.Response[*management.CreateTokenExchangeProfileResponseContent], error)
- func (r *RawClient) Delete(ctx context.Context, id string, opts ...option.RequestOption) (*core.Response[any], error)
- func (r *RawClient) Get(ctx context.Context, id string, opts ...option.RequestOption) (*core.Response[*management.GetTokenExchangeProfileResponseContent], error)
- func (r *RawClient) Update(ctx context.Context, id string, ...) (*core.Response[any], error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
WithRawResponse *RawClient
// contains filtered or unexported fields
}
func NewClient ¶
func NewClient(options *core.RequestOptions) *Client
func (*Client) Create ¶
func (c *Client) Create( ctx context.Context, request *management.CreateTokenExchangeProfileRequestContent, opts ...option.RequestOption, ) (*management.CreateTokenExchangeProfileResponseContent, error)
Create a new Token Exchange Profile within your tenant.
By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
func (*Client) Delete ¶
Delete a Token Exchange Profile within your tenant.
By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
func (*Client) Get ¶
func (c *Client) Get( ctx context.Context, id string, opts ...option.RequestOption, ) (*management.GetTokenExchangeProfileResponseContent, error)
Retrieve details about a single Token Exchange Profile specified by ID.
By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
func (*Client) List ¶
func (c *Client) List( ctx context.Context, request *management.TokenExchangeProfilesListRequest, opts ...option.RequestOption, ) (*core.Page[*string, *management.TokenExchangeProfileResponseContent, *management.ListTokenExchangeProfileResponseContent], error)
Retrieve a list of all Token Exchange Profiles available in your tenant.
By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
This endpoint supports Checkpoint pagination. To search by checkpoint, use the following parameters:
- `from`: Optional id from which to start selection. - `take`: The total amount of entries to retrieve when using the from parameter. Defaults to 50.
**Note**: The first time you call this endpoint using checkpoint pagination, omit the `from` parameter. If there are more results, a `next` value is included in the response. You can use this for subsequent API calls. When `next` is no longer included in the response, no pages are remaining.
func (*Client) Update ¶
func (c *Client) Update( ctx context.Context, id string, request *management.UpdateTokenExchangeProfileRequestContent, opts ...option.RequestOption, ) error
Update a Token Exchange Profile within your tenant.
By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
type RawClient ¶
type RawClient struct {
// contains filtered or unexported fields
}
func NewRawClient ¶
func NewRawClient(options *core.RequestOptions) *RawClient
func (*RawClient) Create ¶
func (r *RawClient) Create( ctx context.Context, request *management.CreateTokenExchangeProfileRequestContent, opts ...option.RequestOption, ) (*core.Response[*management.CreateTokenExchangeProfileResponseContent], error)
func (*RawClient) Get ¶
func (r *RawClient) Get( ctx context.Context, id string, opts ...option.RequestOption, ) (*core.Response[*management.GetTokenExchangeProfileResponseContent], error)
func (*RawClient) Update ¶
func (r *RawClient) Update( ctx context.Context, id string, request *management.UpdateTokenExchangeProfileRequestContent, opts ...option.RequestOption, ) (*core.Response[any], error)