o_auth

package
v0.49.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 21, 2023 License: MIT Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	AuthorizationCodeConstant  = "code"
	AuthorizationTokenConstant = "token"
)

Get the enum in AuthorizationParams

View Source 
const (
	TokenGrantAuthorizationCodeConstant = "authorization_code"
	TokenGrantClientCredentialsConstant = "client_credentials"
	TokenGrantPasswordConstant          = "password"
	TokenGrantRefreshTokenConstant      = "refresh_token"
)

Get the enum in TokenGrantParams

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthorizationFound added in v0.2.0 

type AuthorizationFound struct {
	Location string
}

AuthorizationFound handles this case with default header values. 

Found

func NewAuthorizationFound added in v0.2.0 

func NewAuthorizationFound() *AuthorizationFound

NewAuthorizationFound creates a AuthorizationFound with default headers values

func (*AuthorizationFound) Error added in v0.2.0 

func (o *AuthorizationFound) Error() string

type AuthorizationParams added in v0.2.0 

type AuthorizationParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Login
	  User Name

	*/
	Login *string
	/*Password
	  Password

	*/
	Password *string
	/*Scope
	  Scope. The scope of request by roleId. Accept multiple roleIds separated by whitespace.

	*/
	Scope *string
	/*State
	  State. Random value for preventing cross-site request forgery used by client.

	*/
	State *string
	/*ClientID
	  Client id

	*/
	ClientID string
	/*RedirectURI
	  Redirect URI. The URI has to match one of the URIs set in client.

	*/
	RedirectURI string
	/*ResponseType
	  Response Type. Allowed values ['code', 'token'].

	*/
	ResponseType string

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client
	// contains filtered or unexported fields
}

AuthorizationParams contains all the parameters to send to the API endpoint for the authorization operation typically these are written to a http.Request

func NewAuthorizationParams added in v0.2.0 

func NewAuthorizationParams() *AuthorizationParams

NewAuthorizationParams creates a new AuthorizationParams object with the default values initialized.

func NewAuthorizationParamsWithContext added in v0.2.0 

func NewAuthorizationParamsWithContext(ctx context.Context) *AuthorizationParams

NewAuthorizationParamsWithContext creates a new AuthorizationParams object with the default values initialized, and the ability to set a context for a request

func NewAuthorizationParamsWithHTTPClient added in v0.2.0 

func NewAuthorizationParamsWithHTTPClient(client *http.Client) *AuthorizationParams

NewAuthorizationParamsWithHTTPClient creates a new AuthorizationParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewAuthorizationParamsWithTimeout added in v0.2.0 

func NewAuthorizationParamsWithTimeout(timeout time.Duration) *AuthorizationParams

NewAuthorizationParamsWithTimeout creates a new AuthorizationParams object with the default values initialized, and the ability to set a timeout on a request

func (*AuthorizationParams) SetAuthInfoWriter added in v0.17.0 

func (o *AuthorizationParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the authorization params

func (*AuthorizationParams) SetClientID added in v0.2.0 

func (o *AuthorizationParams) SetClientID(clientID string)

SetClientID adds the clientId to the authorization params

func (*AuthorizationParams) SetContext added in v0.2.0 

func (o *AuthorizationParams) SetContext(ctx context.Context)

SetContext adds the context to the authorization params

func (*AuthorizationParams) SetHTTPClient added in v0.2.0 

func (o *AuthorizationParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the authorization params

func (*AuthorizationParams) SetHTTPClientTransport added in v0.19.0 

func (o *AuthorizationParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the authorization params

func (*AuthorizationParams) SetLogin added in v0.2.0 

func (o *AuthorizationParams) SetLogin(login *string)

SetLogin adds the login to the authorization params

func (*AuthorizationParams) SetPassword added in v0.2.0 

func (o *AuthorizationParams) SetPassword(password *string)

SetPassword adds the password to the authorization params

func (*AuthorizationParams) SetRedirectURI added in v0.2.0 

func (o *AuthorizationParams) SetRedirectURI(redirectURI string)

SetRedirectURI adds the redirectUri to the authorization params

func (*AuthorizationParams) SetResponseType added in v0.2.0 

func (o *AuthorizationParams) SetResponseType(responseType string)

SetResponseType adds the responseType to the authorization params

func (*AuthorizationParams) SetScope added in v0.2.0 

func (o *AuthorizationParams) SetScope(scope *string)

SetScope adds the scope to the authorization params

func (*AuthorizationParams) SetState added in v0.2.0 

func (o *AuthorizationParams) SetState(state *string)

SetState adds the state to the authorization params

func (*AuthorizationParams) SetTimeout added in v0.2.0 

func (o *AuthorizationParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the authorization params

func (*AuthorizationParams) WithClientID added in v0.2.0 

func (o *AuthorizationParams) WithClientID(clientID string) *AuthorizationParams

WithClientID adds the clientID to the authorization params

func (*AuthorizationParams) WithContext added in v0.2.0 

func (o *AuthorizationParams) WithContext(ctx context.Context) *AuthorizationParams

WithContext adds the context to the authorization params

func (*AuthorizationParams) WithHTTPClient added in v0.2.0 

func (o *AuthorizationParams) WithHTTPClient(client *http.Client) *AuthorizationParams

WithHTTPClient adds the HTTPClient to the authorization params

func (*AuthorizationParams) WithLogin added in v0.2.0 

func (o *AuthorizationParams) WithLogin(login *string) *AuthorizationParams

WithLogin adds the login to the authorization params

func (*AuthorizationParams) WithPassword added in v0.2.0 

func (o *AuthorizationParams) WithPassword(password *string) *AuthorizationParams

WithPassword adds the password to the authorization params

func (*AuthorizationParams) WithRedirectURI added in v0.2.0 

func (o *AuthorizationParams) WithRedirectURI(redirectURI string) *AuthorizationParams

WithRedirectURI adds the redirectURI to the authorization params

func (*AuthorizationParams) WithResponseType added in v0.2.0 

func (o *AuthorizationParams) WithResponseType(responseType string) *AuthorizationParams

WithResponseType adds the responseType to the authorization params

func (*AuthorizationParams) WithScope added in v0.2.0 

func (o *AuthorizationParams) WithScope(scope *string) *AuthorizationParams

WithScope adds the scope to the authorization params

func (*AuthorizationParams) WithState added in v0.2.0 

func (o *AuthorizationParams) WithState(state *string) *AuthorizationParams

WithState adds the state to the authorization params

func (*AuthorizationParams) WithTimeout added in v0.2.0 

func (o *AuthorizationParams) WithTimeout(timeout time.Duration) *AuthorizationParams

WithTimeout adds the timeout to the authorization params

func (*AuthorizationParams) WriteToRequest added in v0.2.0 

func (o *AuthorizationParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type AuthorizationReader added in v0.2.0 

type AuthorizationReader struct {
	// contains filtered or unexported fields
}

AuthorizationReader is a Reader for the Authorization structure.

func (*AuthorizationReader) ReadResponse added in v0.2.0 

func (o *AuthorizationReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client for o auth API

func (*Client) Authorization deprecated added in v0.2.0 

func (a *Client) Authorization(params *AuthorizationParams, authInfo runtime.ClientAuthInfoWriter) (*AuthorizationFound, error)

Deprecated: 2022-08-10 - Use AuthorizationShort instead.

Authorization oauth2 authorize api

## The endpoint is going to be deprecated

The endpoint supports two response types:

1. Response Type == "code":

The endpoint returns an authorization code that will be used by the IAM client to exchange for an access token. It supports two different headers, the basic and the bearer header. Each behaves differently. 

*

The basic header

The basic header�s value is the base64 of the client ID and client secret. It is used by the developer whenever the developer authorizes a user on a same namespace. 

*

The bearer header

The bearer header�s value is an access token. It is used by the developer whenever the developer authorizes a user on a different namespace. The endpoint validates user�s entitlement on the designated namespace for making sure the user is authorized for a designated namespace.

Following are the responses returned by the endpoint:

  • Authorize success : redirects to the given URL with the following information: ?code={authorization code}&state;={state}

  • Authorize failure : redirects to the given URL with the following information:?error=access_denied&error;_description=...

    2. Response Type == "token" (Implicit) is deprecated.

    Endpoint migration guide

  • Substitute endpoint (for: basic header style): /iam/v3/oauth/authorize [GET]

  • Substitute endpoint (for: bearer header style): step1: /iam/v3/namespace/{namespace}/token/request [POST] => get code step2: /iam/v3/token/exchange [POST] => get token by step1's code

  • Note: 1. V3 is standard OAuth2 flow and support PKCE 2. Will not support implicit flow in v3.

func (*Client) AuthorizationShort added in v0.8.0 

func (a *Client) AuthorizationShort(params *AuthorizationParams, authInfo runtime.ClientAuthInfoWriter) (*AuthorizationFound, error)

AuthorizationShort oauth2 authorize api

## The endpoint is going to be deprecated

The endpoint supports two response types:

1. Response Type == "code":

The endpoint returns an authorization code that will be used by the IAM client to exchange for an access token. It supports two different headers, the basic and the bearer header. Each behaves differently. 

*

The basic header

The basic header�s value is the base64 of the client ID and client secret. It is used by the developer whenever the developer authorizes a user on a same namespace. 

*

The bearer header

The bearer header�s value is an access token. It is used by the developer whenever the developer authorizes a user on a different namespace. The endpoint validates user�s entitlement on the designated namespace for making sure the user is authorized for a designated namespace.

Following are the responses returned by the endpoint:

  • Authorize success : redirects to the given URL with the following information: ?code={authorization code}&state;={state}

  • Authorize failure : redirects to the given URL with the following information:?error=access_denied&error;_description=...

    2. Response Type == "token" (Implicit) is deprecated.

    Endpoint migration guide

  • Substitute endpoint (for: basic header style): /iam/v3/oauth/authorize [GET]

  • Substitute endpoint (for: bearer header style): step1: /iam/v3/namespace/{namespace}/token/request [POST] => get code step2: /iam/v3/token/exchange [POST] => get token by step1's code

  • Note: 1. V3 is standard OAuth2 flow and support PKCE 2. Will not support implicit flow in v3.

func (*Client) GetJWKS deprecated added in v0.2.0 

func (a *Client) GetJWKS(params *GetJWKSParams, authInfo runtime.ClientAuthInfoWriter) (*GetJWKSOK, error)

Deprecated: 2022-08-10 - Use GetJWKSShort instead.

GetJWKS json web key set for verifying jwt

## The endpoint is going to be deprecated

This endpoint serves public keys for verifying JWT access tokens generated by this service.

When a client application wants to verify a JWT token, it needs to get the 'kid' value found in the JWT token header and use it to look up the corresponding public key from a set returned by this endpoint. The client application can then use that public key to verify the JWT.

A client application might cache the keys so it doesn't need to do request every time it needs to verify a JWT token. If a client application caches the keys and a key with the same 'kid' cannot be found in the cache, it should then try to refresh the keys by making a request to this endpoint again.

Please refer to the RFC for more information about JWK (JSON Web Key): https://tools.ietf.org/html/rfc7517

Endpoint migration guide

  • Substitute endpoint: /iam/v3/oauth/jwks [GET]

func (*Client) GetJWKSShort added in v0.8.0 

func (a *Client) GetJWKSShort(params *GetJWKSParams, authInfo runtime.ClientAuthInfoWriter) (*GetJWKSOK, error)

GetJWKSShort json web key set for verifying jwt

## The endpoint is going to be deprecated

This endpoint serves public keys for verifying JWT access tokens generated by this service.

When a client application wants to verify a JWT token, it needs to get the 'kid' value found in the JWT token header and use it to look up the corresponding public key from a set returned by this endpoint. The client application can then use that public key to verify the JWT.

A client application might cache the keys so it doesn't need to do request every time it needs to verify a JWT token. If a client application caches the keys and a key with the same 'kid' cannot be found in the cache, it should then try to refresh the keys by making a request to this endpoint again.

Please refer to the RFC for more information about JWK (JSON Web Key): https://tools.ietf.org/html/rfc7517

Endpoint migration guide

  • Substitute endpoint: /iam/v3/oauth/jwks [GET]

func (*Client) GetRevocationList deprecated added in v0.2.0 

func (a *Client) GetRevocationList(params *GetRevocationListParams, authInfo runtime.ClientAuthInfoWriter) (*GetRevocationListOK, *GetRevocationListUnauthorized, error)

Deprecated: 2022-08-10 - Use GetRevocationListShort instead.

GetRevocationList oauth2 revocation list api

## The endpoint is going to be deprecated

This endpoint will return a list of revoked users and revoked tokens. List of revoked tokens in bloom filter format. This endpoint requires all requests to have Authorization header set with Basic access authentication constructed from client id and client secret.

The bloom filter uses MurmurHash3 algorithm for hashing the values

Endpoint migration guide

  • Substitute endpoint: /iam/v3/oauth/revocationlist [GET]

func (*Client) GetRevocationListShort added in v0.8.0 

func (a *Client) GetRevocationListShort(params *GetRevocationListParams, authInfo runtime.ClientAuthInfoWriter) (*GetRevocationListOK, error)

GetRevocationListShort oauth2 revocation list api

## The endpoint is going to be deprecated

This endpoint will return a list of revoked users and revoked tokens. List of revoked tokens in bloom filter format. This endpoint requires all requests to have Authorization header set with Basic access authentication constructed from client id and client secret.

The bloom filter uses MurmurHash3 algorithm for hashing the values

Endpoint migration guide

  • Substitute endpoint: /iam/v3/oauth/revocationlist [GET]

func (*Client) PlatformTokenRequestHandler deprecated added in v0.2.0 

func (a *Client) PlatformTokenRequestHandler(params *PlatformTokenRequestHandlerParams, authInfo runtime.ClientAuthInfoWriter) (*PlatformTokenRequestHandlerOK, *PlatformTokenRequestHandlerBadRequest, *PlatformTokenRequestHandlerUnauthorized, error)

Deprecated: 2022-08-10 - Use PlatformTokenRequestHandlerShort instead.

PlatformTokenRequestHandler oauth2 access token generation specific to platform

## The endpoint is going to be deprecated

This endpoint requires all requests to have Authorization header set with Basic access authentication constructed from client id and client secret. For publisher-game namespace schema : Specify only either platform_token or device_id. Device token grant should be requested along with device_id parameter against game namespace. Another 3rd party platform token grant should be requested along with platform_token parameter against publisher namespace.

Supported platforms:

  1. steamopenid : Steam's user authentication method using OpenID 2.0. The expected value of the platform token is the URL generated by Steam on web authentication

The JWT contains user's active bans with its expiry date. List of ban types can be obtained from /iam/bans.

. Endpoint migration guide

  • Substitute endpoint: /iam/v3/oauth/platforms/{platformId}/token [POST]

func (*Client) PlatformTokenRequestHandlerShort added in v0.8.0 

func (a *Client) PlatformTokenRequestHandlerShort(params *PlatformTokenRequestHandlerParams, authInfo runtime.ClientAuthInfoWriter) (*PlatformTokenRequestHandlerOK, error)

PlatformTokenRequestHandlerShort oauth2 access token generation specific to platform

## The endpoint is going to be deprecated

This endpoint requires all requests to have Authorization header set with Basic access authentication constructed from client id and client secret. For publisher-game namespace schema : Specify only either platform_token or device_id. Device token grant should be requested along with device_id parameter against game namespace. Another 3rd party platform token grant should be requested along with platform_token parameter against publisher namespace.

Supported platforms:

  1. steamopenid : Steam's user authentication method using OpenID 2.0. The expected value of the platform token is the URL generated by Steam on web authentication

The JWT contains user's active bans with its expiry date. List of ban types can be obtained from /iam/bans.

. Endpoint migration guide

  • Substitute endpoint: /iam/v3/oauth/platforms/{platformId}/token [POST]

func (*Client) RevokeAUser deprecated added in v0.2.0 

func (a *Client) RevokeAUser(params *RevokeAUserParams, authInfo runtime.ClientAuthInfoWriter) (*RevokeAUserOK, *RevokeAUserBadRequest, *RevokeAUserUnauthorized, error)

Deprecated: 2022-08-10 - Use RevokeAUserShort instead.

RevokeAUser oauth2 user revocation api

## The endpoint is going to be deprecated

This endpoint revokes a user.

This endpoint requires all requests to have Authorization header set with Bearer access authentication with valid access token.

Required permission 'NAMESPACE:{namespace}:USER:{userID}:ADMIN [UPDATE]'

When other clients know that the userID has been revoked and the token is issued before the revocation, forcing a new token will contain banned permissions.

Endpoint migration guide

  • Substitute endpoint: /iam/v3/oauth/admin/namespaces/{namespace}/users/{userId}/revoke [POST]

func (*Client) RevokeAUserShort added in v0.8.0 

func (a *Client) RevokeAUserShort(params *RevokeAUserParams, authInfo runtime.ClientAuthInfoWriter) (*RevokeAUserOK, error)

RevokeAUserShort oauth2 user revocation api

## The endpoint is going to be deprecated

This endpoint revokes a user.

This endpoint requires all requests to have Authorization header set with Bearer access authentication with valid access token.

Required permission 'NAMESPACE:{namespace}:USER:{userID}:ADMIN [UPDATE]'

When other clients know that the userID has been revoked and the token is issued before the revocation, forcing a new token will contain banned permissions.

Endpoint migration guide

  • Substitute endpoint: /iam/v3/oauth/admin/namespaces/{namespace}/users/{userId}/revoke [POST]

func (*Client) RevokeToken deprecated added in v0.2.0 

func (a *Client) RevokeToken(params *RevokeTokenParams, authInfo runtime.ClientAuthInfoWriter) (*RevokeTokenOK, *RevokeTokenBadRequest, *RevokeTokenUnauthorized, error)

Deprecated: 2022-08-10 - Use RevokeTokenShort instead.

RevokeToken oauth2 token revocation api

## The endpoint is going to be deprecated

Revokes a token.

This endpoint requires all requests to have Authorization header set with Basic access authentication constructed from client id and client secret or Bearer access authentication with valid access token.

Endpoint migration guide

  • Substitute endpoint: /v3/oauth/revoke [POST]

func (*Client) RevokeTokenShort added in v0.8.0 

func (a *Client) RevokeTokenShort(params *RevokeTokenParams, authInfo runtime.ClientAuthInfoWriter) (*RevokeTokenOK, error)

RevokeTokenShort oauth2 token revocation api

## The endpoint is going to be deprecated

Revokes a token.

This endpoint requires all requests to have Authorization header set with Basic access authentication constructed from client id and client secret or Bearer access authentication with valid access token.

Endpoint migration guide

  • Substitute endpoint: /v3/oauth/revoke [POST]

func (*Client) RevokeUser deprecated added in v0.2.0 

func (a *Client) RevokeUser(params *RevokeUserParams, authInfo runtime.ClientAuthInfoWriter) (*RevokeUserOK, *RevokeUserUnauthorized, error)

Deprecated: 2022-08-10 - Use RevokeUserShort instead.

RevokeUser revokes user's tokens'

## The endpoint is going to be deprecated

This endpoint requires all requests to have authorization header set with bearer token.

Required permission 'ADMIN:NAMESPACE:{namespace}:USER:{userId} [UPDATE]'

The endpoint revokes all access tokens and refresh tokens a user has prior the revocation time. It is a convenient feature for the developer (or admin) who wanted to revokes all user's access tokens and refresh tokens generated before some period of time.

Endpoint migration guide

  • Substitute endpoint: /iam/v3/oauth/admin/namespaces/{namespace}/users/{userId}/revoke [POST]

func (*Client) RevokeUserShort added in v0.8.0 

func (a *Client) RevokeUserShort(params *RevokeUserParams, authInfo runtime.ClientAuthInfoWriter) (*RevokeUserOK, error)

RevokeUserShort revokes user's tokens'

## The endpoint is going to be deprecated

This endpoint requires all requests to have authorization header set with bearer token.

Required permission 'ADMIN:NAMESPACE:{namespace}:USER:{userId} [UPDATE]'

The endpoint revokes all access tokens and refresh tokens a user has prior the revocation time. It is a convenient feature for the developer (or admin) who wanted to revokes all user's access tokens and refresh tokens generated before some period of time.

Endpoint migration guide

  • Substitute endpoint: /iam/v3/oauth/admin/namespaces/{namespace}/users/{userId}/revoke [POST]

func (*Client) SetTransport 

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

func (*Client) TokenGrant deprecated 

func (a *Client) TokenGrant(params *TokenGrantParams, authInfo runtime.ClientAuthInfoWriter) (*TokenGrantOK, *TokenGrantBadRequest, *TokenGrantUnauthorized, error)

Deprecated: 2022-08-10 - Use TokenGrantShort instead.

TokenGrant oauth2 access token generation endpoint

## The endpoint is going to be deprecated

Endpoint migration guide

  • Substitute endpoint: /iam/v3/oauth/token [POST]

  • Note: difference in V3 response: 1. format differenceï¼�Pascal case => Camel case): permissions field from Action => action, Resource => resource

This endpoint requires all requests to have `Authorization` header set with `Basic` access authentication constructed from client id and client secret.

This endpoint supports different grant types :

  1. Grant Type == `client_credentials`:

    This endpoint will check the client credentials provided through Authorization header.

  2. Grant Type == `password`:

    The grant type to use for authenticating a user, whether it's by email / username and password combination

or through platform.

  1. Grant Type == `refresh_token`:

    Used to get a new access token for a valid refresh token.

  2. Grant Type == `authorization_code`:

    It generates the user token by given the authorization

code which generated in "/authorize" API response. It should also pass in the redirect_uri, which should be the same as generating the authorization code request.

For platform authentication, use grant type `password`. The `username` field would be in form of `platform:<platform type>`, for example `platform:steam` for Steam. For the `password` field, set it to the authentication/authorization ticket or token obtainable through the respective platform SDK after authenticated the user to the platform. Supported platforms:

  • steam - use `platform:steam` as the username and use the authentication ticket obtained

from Steam through the Steam SDK as the password.

  • ps4 - use `platform:ps4` as the username and use the authorization code

obtained from the PlayStation Network through a player PS4 unit as the password.

  • live - use `platform:live` as the username and use token obtained from

Xbox Secure Token Service (XSTS) as the password.

  • oculus - use `platform:oculus` as the username and use the `user_id:nonce`

as password obtained from Oculus through the Oculus SDK.

The access token and refresh token are in form of JWT token. An access token JWT contains data which structure is similar to the Response Class below, but without OAuth-related data. To verify a token, use the public keys obtained from the `/jwks` endpoint below.

## Access Token Content

Following is the access token�s content: 

*

namespace. It is the namespace the token was generated from. 

*

display_name. The display name of the sub. It is empty if the token is generated from the client credential 

*

roles. The sub�s roles. It is empty if the token is generated from the client credential 

*

namespace_roles. The sub�s roles scoped to namespace. Improvement from roles, which make the role scoped to specific namespace instead of global to publisher namespace 

*

permissions. The sub or aud� permissions 

*

bans. The sub�s list of bans. It is used by the IAM client for validating the token. 

*

jflgs. It stands for Justice Flags. It is a special flag used for storing additional status information regarding the sub. It is implemented as a bit mask. Following explains what each bit represents:

  • 1: Email Address Verified

  • 2: Phone Number Verified

  • 4: Anonymous

    *

aud. The aud is the client ID. 

*

iat. The time the token issues at. It is in Epoch time format 

*

exp. The time the token expires. It is in Epoch time format 

*

sub. The UserID. The sub is omitted if the token is generated from client credential

## Bans

The JWT contains user's active bans with its expiry date. List of ban types can be obtained from /bans.

## Track Login History

This endpoint will track login history to detect suspicious login activity, please provide "device_id" (alphanumeric) in request header parameter otherwise we will set to "unknown".

Align with General Data Protection Regulation in Europe, user login history will be kept within 28 days by default"

func (*Client) TokenGrantShort added in v0.8.0 

func (a *Client) TokenGrantShort(params *TokenGrantParams, authInfo runtime.ClientAuthInfoWriter) (*TokenGrantOK, error)

TokenGrantShort oauth2 access token generation endpoint

## The endpoint is going to be deprecated

Endpoint migration guide

  • Substitute endpoint: /iam/v3/oauth/token [POST]

  • Note: difference in V3 response: 1. format differenceï¼�Pascal case => Camel case): permissions field from Action => action, Resource => resource

This endpoint requires all requests to have `Authorization` header set with `Basic` access authentication constructed from client id and client secret.

This endpoint supports different grant types :

  1. Grant Type == `client_credentials`:

    This endpoint will check the client credentials provided through Authorization header.

  2. Grant Type == `password`:

    The grant type to use for authenticating a user, whether it's by email / username and password combination

or through platform.

  1. Grant Type == `refresh_token`:

    Used to get a new access token for a valid refresh token.

  2. Grant Type == `authorization_code`:

    It generates the user token by given the authorization

code which generated in "/authorize" API response. It should also pass in the redirect_uri, which should be the same as generating the authorization code request.

For platform authentication, use grant type `password`. The `username` field would be in form of `platform:<platform type>`, for example `platform:steam` for Steam. For the `password` field, set it to the authentication/authorization ticket or token obtainable through the respective platform SDK after authenticated the user to the platform. Supported platforms:

  • steam - use `platform:steam` as the username and use the authentication ticket obtained

from Steam through the Steam SDK as the password.

  • ps4 - use `platform:ps4` as the username and use the authorization code

obtained from the PlayStation Network through a player PS4 unit as the password.

  • live - use `platform:live` as the username and use token obtained from

Xbox Secure Token Service (XSTS) as the password.

  • oculus - use `platform:oculus` as the username and use the `user_id:nonce`

as password obtained from Oculus through the Oculus SDK.

The access token and refresh token are in form of JWT token. An access token JWT contains data which structure is similar to the Response Class below, but without OAuth-related data. To verify a token, use the public keys obtained from the `/jwks` endpoint below.

## Access Token Content

Following is the access token�s content: 

*

namespace. It is the namespace the token was generated from. 

*

display_name. The display name of the sub. It is empty if the token is generated from the client credential 

*

roles. The sub�s roles. It is empty if the token is generated from the client credential 

*

namespace_roles. The sub�s roles scoped to namespace. Improvement from roles, which make the role scoped to specific namespace instead of global to publisher namespace 

*

permissions. The sub or aud� permissions 

*

bans. The sub�s list of bans. It is used by the IAM client for validating the token. 

*

jflgs. It stands for Justice Flags. It is a special flag used for storing additional status information regarding the sub. It is implemented as a bit mask. Following explains what each bit represents:

  • 1: Email Address Verified

  • 2: Phone Number Verified

  • 4: Anonymous

    *

aud. The aud is the client ID. 

*

iat. The time the token issues at. It is in Epoch time format 

*

exp. The time the token expires. It is in Epoch time format 

*

sub. The UserID. The sub is omitted if the token is generated from client credential

## Bans

The JWT contains user's active bans with its expiry date. List of ban types can be obtained from /bans.

## Track Login History

This endpoint will track login history to detect suspicious login activity, please provide "device_id" (alphanumeric) in request header parameter otherwise we will set to "unknown".

Align with General Data Protection Regulation in Europe, user login history will be kept within 28 days by default"

func (*Client) VerifyToken deprecated added in v0.2.0 

func (a *Client) VerifyToken(params *VerifyTokenParams, authInfo runtime.ClientAuthInfoWriter) (*VerifyTokenOK, *VerifyTokenBadRequest, error)

Deprecated: 2022-08-10 - Use VerifyTokenShort instead.

VerifyToken oauth2 token verification api

## The endpoint is going to be deprecated

This endpoint requires all requests to have Authorization header set with Basic access authentication constructed from client id and client secret. Endpoint migration guide

  • Substitute endpoint: /iam/v3/oauth/verify [POST]

  • Note: difference in V3 response: 1. format differenceï¼�Pascal case => Camel case): permissions field from Action => action, Resource => resource

func (*Client) VerifyTokenShort added in v0.8.0 

func (a *Client) VerifyTokenShort(params *VerifyTokenParams, authInfo runtime.ClientAuthInfoWriter) (*VerifyTokenOK, error)

VerifyTokenShort oauth2 token verification api

## The endpoint is going to be deprecated

This endpoint requires all requests to have Authorization header set with Basic access authentication constructed from client id and client secret. Endpoint migration guide

  • Substitute endpoint: /iam/v3/oauth/verify [POST]

  • Note: difference in V3 response: 1. format differenceï¼�Pascal case => Camel case): permissions field from Action => action, Resource => resource

type ClientService 

type ClientService interface {
	Authorization(params *AuthorizationParams, authInfo runtime.ClientAuthInfoWriter) (*AuthorizationFound, error)
	AuthorizationShort(params *AuthorizationParams, authInfo runtime.ClientAuthInfoWriter) (*AuthorizationFound, error)
	GetJWKS(params *GetJWKSParams, authInfo runtime.ClientAuthInfoWriter) (*GetJWKSOK, error)
	GetJWKSShort(params *GetJWKSParams, authInfo runtime.ClientAuthInfoWriter) (*GetJWKSOK, error)
	PlatformTokenRequestHandler(params *PlatformTokenRequestHandlerParams, authInfo runtime.ClientAuthInfoWriter) (*PlatformTokenRequestHandlerOK, *PlatformTokenRequestHandlerBadRequest, *PlatformTokenRequestHandlerUnauthorized, error)
	PlatformTokenRequestHandlerShort(params *PlatformTokenRequestHandlerParams, authInfo runtime.ClientAuthInfoWriter) (*PlatformTokenRequestHandlerOK, error)
	RevokeUser(params *RevokeUserParams, authInfo runtime.ClientAuthInfoWriter) (*RevokeUserOK, *RevokeUserUnauthorized, error)
	RevokeUserShort(params *RevokeUserParams, authInfo runtime.ClientAuthInfoWriter) (*RevokeUserOK, error)
	GetRevocationList(params *GetRevocationListParams, authInfo runtime.ClientAuthInfoWriter) (*GetRevocationListOK, *GetRevocationListUnauthorized, error)
	GetRevocationListShort(params *GetRevocationListParams, authInfo runtime.ClientAuthInfoWriter) (*GetRevocationListOK, error)
	RevokeToken(params *RevokeTokenParams, authInfo runtime.ClientAuthInfoWriter) (*RevokeTokenOK, *RevokeTokenBadRequest, *RevokeTokenUnauthorized, error)
	RevokeTokenShort(params *RevokeTokenParams, authInfo runtime.ClientAuthInfoWriter) (*RevokeTokenOK, error)
	RevokeAUser(params *RevokeAUserParams, authInfo runtime.ClientAuthInfoWriter) (*RevokeAUserOK, *RevokeAUserBadRequest, *RevokeAUserUnauthorized, error)
	RevokeAUserShort(params *RevokeAUserParams, authInfo runtime.ClientAuthInfoWriter) (*RevokeAUserOK, error)
	TokenGrant(params *TokenGrantParams, authInfo runtime.ClientAuthInfoWriter) (*TokenGrantOK, *TokenGrantBadRequest, *TokenGrantUnauthorized, error)
	TokenGrantShort(params *TokenGrantParams, authInfo runtime.ClientAuthInfoWriter) (*TokenGrantOK, error)
	VerifyToken(params *VerifyTokenParams, authInfo runtime.ClientAuthInfoWriter) (*VerifyTokenOK, *VerifyTokenBadRequest, error)
	VerifyTokenShort(params *VerifyTokenParams, authInfo runtime.ClientAuthInfoWriter) (*VerifyTokenOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New 

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new o auth API client.

type GetJWKSOK added in v0.2.0 

type GetJWKSOK struct {
	Payload *iamclientmodels.OauthcommonJWKSet
}

GetJWKSOK handles this case with default header values. 

JWKS returned

func NewGetJWKSOK added in v0.2.0 

func NewGetJWKSOK() *GetJWKSOK

NewGetJWKSOK creates a GetJWKSOK with default headers values

func (*GetJWKSOK) Error added in v0.2.0 

func (o *GetJWKSOK) Error() string

func (*GetJWKSOK) GetPayload added in v0.2.0 

func (o *GetJWKSOK) GetPayload() *iamclientmodels.OauthcommonJWKSet

func (*GetJWKSOK) ToJSONString added in v0.25.0 

func (o *GetJWKSOK) ToJSONString() string

type GetJWKSParams added in v0.2.0 

type GetJWKSParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client
	// contains filtered or unexported fields
}

GetJWKSParams contains all the parameters to send to the API endpoint for the get jwks operation typically these are written to a http.Request

func NewGetJWKSParams added in v0.2.0 

func NewGetJWKSParams() *GetJWKSParams

NewGetJWKSParams creates a new GetJWKSParams object with the default values initialized.

func NewGetJWKSParamsWithContext added in v0.2.0 

func NewGetJWKSParamsWithContext(ctx context.Context) *GetJWKSParams

NewGetJWKSParamsWithContext creates a new GetJWKSParams object with the default values initialized, and the ability to set a context for a request

func NewGetJWKSParamsWithHTTPClient added in v0.2.0 

func NewGetJWKSParamsWithHTTPClient(client *http.Client) *GetJWKSParams

NewGetJWKSParamsWithHTTPClient creates a new GetJWKSParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewGetJWKSParamsWithTimeout added in v0.2.0 

func NewGetJWKSParamsWithTimeout(timeout time.Duration) *GetJWKSParams

NewGetJWKSParamsWithTimeout creates a new GetJWKSParams object with the default values initialized, and the ability to set a timeout on a request

func (*GetJWKSParams) SetAuthInfoWriter added in v0.17.0 

func (o *GetJWKSParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the get jwks params

func (*GetJWKSParams) SetContext added in v0.2.0 

func (o *GetJWKSParams) SetContext(ctx context.Context)

SetContext adds the context to the get jwks params

func (*GetJWKSParams) SetHTTPClient added in v0.2.0 

func (o *GetJWKSParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get jwks params

func (*GetJWKSParams) SetHTTPClientTransport added in v0.19.0 

func (o *GetJWKSParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the get jwks params

func (*GetJWKSParams) SetTimeout added in v0.2.0 

func (o *GetJWKSParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get jwks params

func (*GetJWKSParams) WithContext added in v0.2.0 

func (o *GetJWKSParams) WithContext(ctx context.Context) *GetJWKSParams

WithContext adds the context to the get jwks params

func (*GetJWKSParams) WithHTTPClient added in v0.2.0 

func (o *GetJWKSParams) WithHTTPClient(client *http.Client) *GetJWKSParams

WithHTTPClient adds the HTTPClient to the get jwks params

func (*GetJWKSParams) WithTimeout added in v0.2.0 

func (o *GetJWKSParams) WithTimeout(timeout time.Duration) *GetJWKSParams

WithTimeout adds the timeout to the get jwks params

func (*GetJWKSParams) WriteToRequest added in v0.2.0 

func (o *GetJWKSParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetJWKSReader added in v0.2.0 

type GetJWKSReader struct {
	// contains filtered or unexported fields
}

GetJWKSReader is a Reader for the GetJWKS structure.

func (*GetJWKSReader) ReadResponse added in v0.2.0 

func (o *GetJWKSReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetRevocationListOK added in v0.2.0 

type GetRevocationListOK struct {
	Payload *iamclientmodels.OauthapiRevocationList
}

GetRevocationListOK handles this case with default header values. 

revocation list returned

func NewGetRevocationListOK added in v0.2.0 

func NewGetRevocationListOK() *GetRevocationListOK

NewGetRevocationListOK creates a GetRevocationListOK with default headers values

func (*GetRevocationListOK) Error added in v0.2.0 

func (o *GetRevocationListOK) Error() string

func (*GetRevocationListOK) GetPayload added in v0.2.0 

func (o *GetRevocationListOK) GetPayload() *iamclientmodels.OauthapiRevocationList

func (*GetRevocationListOK) ToJSONString added in v0.25.0 

func (o *GetRevocationListOK) ToJSONString() string

type GetRevocationListParams added in v0.2.0 

type GetRevocationListParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client
	// contains filtered or unexported fields
}

GetRevocationListParams contains all the parameters to send to the API endpoint for the get revocation list operation typically these are written to a http.Request

func NewGetRevocationListParams added in v0.2.0 

func NewGetRevocationListParams() *GetRevocationListParams

NewGetRevocationListParams creates a new GetRevocationListParams object with the default values initialized.

func NewGetRevocationListParamsWithContext added in v0.2.0 

func NewGetRevocationListParamsWithContext(ctx context.Context) *GetRevocationListParams

NewGetRevocationListParamsWithContext creates a new GetRevocationListParams object with the default values initialized, and the ability to set a context for a request

func NewGetRevocationListParamsWithHTTPClient added in v0.2.0 

func NewGetRevocationListParamsWithHTTPClient(client *http.Client) *GetRevocationListParams

NewGetRevocationListParamsWithHTTPClient creates a new GetRevocationListParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewGetRevocationListParamsWithTimeout added in v0.2.0 

func NewGetRevocationListParamsWithTimeout(timeout time.Duration) *GetRevocationListParams

NewGetRevocationListParamsWithTimeout creates a new GetRevocationListParams object with the default values initialized, and the ability to set a timeout on a request

func (*GetRevocationListParams) SetAuthInfoWriter added in v0.17.0 

func (o *GetRevocationListParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the get revocation list params

func (*GetRevocationListParams) SetContext added in v0.2.0 

func (o *GetRevocationListParams) SetContext(ctx context.Context)

SetContext adds the context to the get revocation list params

func (*GetRevocationListParams) SetHTTPClient added in v0.2.0 

func (o *GetRevocationListParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get revocation list params

func (*GetRevocationListParams) SetHTTPClientTransport added in v0.19.0 

func (o *GetRevocationListParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the get revocation list params

func (*GetRevocationListParams) SetTimeout added in v0.2.0 

func (o *GetRevocationListParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get revocation list params

func (*GetRevocationListParams) WithContext added in v0.2.0 

func (o *GetRevocationListParams) WithContext(ctx context.Context) *GetRevocationListParams

WithContext adds the context to the get revocation list params

func (*GetRevocationListParams) WithHTTPClient added in v0.2.0 

func (o *GetRevocationListParams) WithHTTPClient(client *http.Client) *GetRevocationListParams

WithHTTPClient adds the HTTPClient to the get revocation list params

func (*GetRevocationListParams) WithTimeout added in v0.2.0 

func (o *GetRevocationListParams) WithTimeout(timeout time.Duration) *GetRevocationListParams

WithTimeout adds the timeout to the get revocation list params

func (*GetRevocationListParams) WriteToRequest added in v0.2.0 

func (o *GetRevocationListParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetRevocationListReader added in v0.2.0 

type GetRevocationListReader struct {
	// contains filtered or unexported fields
}

GetRevocationListReader is a Reader for the GetRevocationList structure.

func (*GetRevocationListReader) ReadResponse added in v0.2.0 

func (o *GetRevocationListReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetRevocationListUnauthorized added in v0.2.0 

type GetRevocationListUnauthorized struct {
}

GetRevocationListUnauthorized handles this case with default header values. 

Invalid basic auth header

func NewGetRevocationListUnauthorized added in v0.2.0 

func NewGetRevocationListUnauthorized() *GetRevocationListUnauthorized

NewGetRevocationListUnauthorized creates a GetRevocationListUnauthorized with default headers values

func (*GetRevocationListUnauthorized) Error added in v0.2.0 

func (o *GetRevocationListUnauthorized) Error() string

type PlatformTokenRequestHandlerBadRequest added in v0.2.0 

type PlatformTokenRequestHandlerBadRequest struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

PlatformTokenRequestHandlerBadRequest handles this case with default header values. 

General request error

func NewPlatformTokenRequestHandlerBadRequest added in v0.2.0 

func NewPlatformTokenRequestHandlerBadRequest() *PlatformTokenRequestHandlerBadRequest

NewPlatformTokenRequestHandlerBadRequest creates a PlatformTokenRequestHandlerBadRequest with default headers values

func (*PlatformTokenRequestHandlerBadRequest) Error added in v0.2.0 

func (o *PlatformTokenRequestHandlerBadRequest) Error() string

func (*PlatformTokenRequestHandlerBadRequest) GetPayload added in v0.2.0 

func (o *PlatformTokenRequestHandlerBadRequest) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*PlatformTokenRequestHandlerBadRequest) ToJSONString added in v0.25.0 

func (o *PlatformTokenRequestHandlerBadRequest) ToJSONString() string

type PlatformTokenRequestHandlerOK added in v0.2.0 

type PlatformTokenRequestHandlerOK struct {
	Payload *iamclientmodels.OauthmodelTokenResponse
}

PlatformTokenRequestHandlerOK handles this case with default header values. 

Access Token returned

func NewPlatformTokenRequestHandlerOK added in v0.2.0 

func NewPlatformTokenRequestHandlerOK() *PlatformTokenRequestHandlerOK

NewPlatformTokenRequestHandlerOK creates a PlatformTokenRequestHandlerOK with default headers values

func (*PlatformTokenRequestHandlerOK) Error added in v0.2.0 

func (o *PlatformTokenRequestHandlerOK) Error() string

func (*PlatformTokenRequestHandlerOK) GetPayload added in v0.2.0 

func (o *PlatformTokenRequestHandlerOK) GetPayload() *iamclientmodels.OauthmodelTokenResponse

func (*PlatformTokenRequestHandlerOK) ToJSONString added in v0.25.0 

func (o *PlatformTokenRequestHandlerOK) ToJSONString() string

type PlatformTokenRequestHandlerParams added in v0.2.0 

type PlatformTokenRequestHandlerParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*DeviceID
	  Device/hardware identifier

	*/
	DeviceID *string
	/*MacAddress
	  Mac address of device

	*/
	MacAddress *string
	/*PlatformToken
	  Token from platform auth

	*/
	PlatformToken *string
	/*Namespace
	  Requested namespace for token grant

	*/
	Namespace string
	/*PlatformID
	  Platform ID to login with

	*/
	PlatformID string

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client
	// contains filtered or unexported fields
}

PlatformTokenRequestHandlerParams contains all the parameters to send to the API endpoint for the platform token request handler operation typically these are written to a http.Request

func NewPlatformTokenRequestHandlerParams added in v0.2.0 

func NewPlatformTokenRequestHandlerParams() *PlatformTokenRequestHandlerParams

NewPlatformTokenRequestHandlerParams creates a new PlatformTokenRequestHandlerParams object with the default values initialized.

func NewPlatformTokenRequestHandlerParamsWithContext added in v0.2.0 

func NewPlatformTokenRequestHandlerParamsWithContext(ctx context.Context) *PlatformTokenRequestHandlerParams

NewPlatformTokenRequestHandlerParamsWithContext creates a new PlatformTokenRequestHandlerParams object with the default values initialized, and the ability to set a context for a request

func NewPlatformTokenRequestHandlerParamsWithHTTPClient added in v0.2.0 

func NewPlatformTokenRequestHandlerParamsWithHTTPClient(client *http.Client) *PlatformTokenRequestHandlerParams

NewPlatformTokenRequestHandlerParamsWithHTTPClient creates a new PlatformTokenRequestHandlerParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewPlatformTokenRequestHandlerParamsWithTimeout added in v0.2.0 

func NewPlatformTokenRequestHandlerParamsWithTimeout(timeout time.Duration) *PlatformTokenRequestHandlerParams

NewPlatformTokenRequestHandlerParamsWithTimeout creates a new PlatformTokenRequestHandlerParams object with the default values initialized, and the ability to set a timeout on a request

func (*PlatformTokenRequestHandlerParams) SetAuthInfoWriter added in v0.17.0 

func (o *PlatformTokenRequestHandlerParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the platform token request handler params

func (*PlatformTokenRequestHandlerParams) SetContext added in v0.2.0 

func (o *PlatformTokenRequestHandlerParams) SetContext(ctx context.Context)

SetContext adds the context to the platform token request handler params

func (*PlatformTokenRequestHandlerParams) SetDeviceID added in v0.2.0 

func (o *PlatformTokenRequestHandlerParams) SetDeviceID(deviceID *string)

SetDeviceID adds the deviceId to the platform token request handler params

func (*PlatformTokenRequestHandlerParams) SetHTTPClient added in v0.2.0 

func (o *PlatformTokenRequestHandlerParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the platform token request handler params

func (*PlatformTokenRequestHandlerParams) SetHTTPClientTransport added in v0.19.0 

func (o *PlatformTokenRequestHandlerParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the platform token request handler params

func (*PlatformTokenRequestHandlerParams) SetMacAddress added in v0.29.0 

func (o *PlatformTokenRequestHandlerParams) SetMacAddress(macAddress *string)

SetMacAddress adds the macAddress to the platform token request handler params

func (*PlatformTokenRequestHandlerParams) SetNamespace added in v0.2.0 

func (o *PlatformTokenRequestHandlerParams) SetNamespace(namespace string)

SetNamespace adds the namespace to the platform token request handler params

func (*PlatformTokenRequestHandlerParams) SetPlatformID added in v0.2.0 

func (o *PlatformTokenRequestHandlerParams) SetPlatformID(platformID string)

SetPlatformID adds the platformId to the platform token request handler params

func (*PlatformTokenRequestHandlerParams) SetPlatformToken added in v0.2.0 

func (o *PlatformTokenRequestHandlerParams) SetPlatformToken(platformToken *string)

SetPlatformToken adds the platformToken to the platform token request handler params

func (*PlatformTokenRequestHandlerParams) SetTimeout added in v0.2.0 

func (o *PlatformTokenRequestHandlerParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the platform token request handler params

func (*PlatformTokenRequestHandlerParams) WithContext added in v0.2.0 

func (o *PlatformTokenRequestHandlerParams) WithContext(ctx context.Context) *PlatformTokenRequestHandlerParams

WithContext adds the context to the platform token request handler params

func (*PlatformTokenRequestHandlerParams) WithDeviceID added in v0.2.0 

func (o *PlatformTokenRequestHandlerParams) WithDeviceID(deviceID *string) *PlatformTokenRequestHandlerParams

WithDeviceID adds the deviceID to the platform token request handler params

func (*PlatformTokenRequestHandlerParams) WithHTTPClient added in v0.2.0 

func (o *PlatformTokenRequestHandlerParams) WithHTTPClient(client *http.Client) *PlatformTokenRequestHandlerParams

WithHTTPClient adds the HTTPClient to the platform token request handler params

func (*PlatformTokenRequestHandlerParams) WithMacAddress added in v0.29.0 

func (o *PlatformTokenRequestHandlerParams) WithMacAddress(macAddress *string) *PlatformTokenRequestHandlerParams

WithMacAddress adds the macAddress to the platform token request handler params

func (*PlatformTokenRequestHandlerParams) WithNamespace added in v0.2.0 

func (o *PlatformTokenRequestHandlerParams) WithNamespace(namespace string) *PlatformTokenRequestHandlerParams

WithNamespace adds the namespace to the platform token request handler params

func (*PlatformTokenRequestHandlerParams) WithPlatformID added in v0.2.0 

func (o *PlatformTokenRequestHandlerParams) WithPlatformID(platformID string) *PlatformTokenRequestHandlerParams

WithPlatformID adds the platformID to the platform token request handler params

func (*PlatformTokenRequestHandlerParams) WithPlatformToken added in v0.2.0 

func (o *PlatformTokenRequestHandlerParams) WithPlatformToken(platformToken *string) *PlatformTokenRequestHandlerParams

WithPlatformToken adds the platformToken to the platform token request handler params

func (*PlatformTokenRequestHandlerParams) WithTimeout added in v0.2.0 

func (o *PlatformTokenRequestHandlerParams) WithTimeout(timeout time.Duration) *PlatformTokenRequestHandlerParams

WithTimeout adds the timeout to the platform token request handler params

func (*PlatformTokenRequestHandlerParams) WriteToRequest added in v0.2.0 

func (o *PlatformTokenRequestHandlerParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type PlatformTokenRequestHandlerReader added in v0.2.0 

type PlatformTokenRequestHandlerReader struct {
	// contains filtered or unexported fields
}

PlatformTokenRequestHandlerReader is a Reader for the PlatformTokenRequestHandler structure.

func (*PlatformTokenRequestHandlerReader) ReadResponse added in v0.2.0 

func (o *PlatformTokenRequestHandlerReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type PlatformTokenRequestHandlerUnauthorized added in v0.2.0 

type PlatformTokenRequestHandlerUnauthorized struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

PlatformTokenRequestHandlerUnauthorized handles this case with default header values. 

Client authentication failed

func NewPlatformTokenRequestHandlerUnauthorized added in v0.2.0 

func NewPlatformTokenRequestHandlerUnauthorized() *PlatformTokenRequestHandlerUnauthorized

NewPlatformTokenRequestHandlerUnauthorized creates a PlatformTokenRequestHandlerUnauthorized with default headers values

func (*PlatformTokenRequestHandlerUnauthorized) Error added in v0.2.0 

func (o *PlatformTokenRequestHandlerUnauthorized) Error() string

func (*PlatformTokenRequestHandlerUnauthorized) GetPayload added in v0.2.0 

func (o *PlatformTokenRequestHandlerUnauthorized) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*PlatformTokenRequestHandlerUnauthorized) ToJSONString added in v0.25.0 

func (o *PlatformTokenRequestHandlerUnauthorized) ToJSONString() string

type RevokeAUserBadRequest added in v0.2.0 

type RevokeAUserBadRequest struct {
}

RevokeAUserBadRequest handles this case with default header values. 

Invalid input

func NewRevokeAUserBadRequest added in v0.2.0 

func NewRevokeAUserBadRequest() *RevokeAUserBadRequest

NewRevokeAUserBadRequest creates a RevokeAUserBadRequest with default headers values

func (*RevokeAUserBadRequest) Error added in v0.2.0 

func (o *RevokeAUserBadRequest) Error() string

type RevokeAUserOK added in v0.2.0 

type RevokeAUserOK struct {
}

RevokeAUserOK handles this case with default header values. 

User revoked or does not exist

func NewRevokeAUserOK added in v0.2.0 

func NewRevokeAUserOK() *RevokeAUserOK

NewRevokeAUserOK creates a RevokeAUserOK with default headers values

func (*RevokeAUserOK) Error added in v0.2.0 

func (o *RevokeAUserOK) Error() string

type RevokeAUserParams added in v0.2.0 

type RevokeAUserParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*UserID
	  User to be revoked

	*/
	UserID string

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client
	// contains filtered or unexported fields
}

RevokeAUserParams contains all the parameters to send to the API endpoint for the revoke a user operation typically these are written to a http.Request

func NewRevokeAUserParams added in v0.2.0 

func NewRevokeAUserParams() *RevokeAUserParams

NewRevokeAUserParams creates a new RevokeAUserParams object with the default values initialized.

func NewRevokeAUserParamsWithContext added in v0.2.0 

func NewRevokeAUserParamsWithContext(ctx context.Context) *RevokeAUserParams

NewRevokeAUserParamsWithContext creates a new RevokeAUserParams object with the default values initialized, and the ability to set a context for a request

func NewRevokeAUserParamsWithHTTPClient added in v0.2.0 

func NewRevokeAUserParamsWithHTTPClient(client *http.Client) *RevokeAUserParams

NewRevokeAUserParamsWithHTTPClient creates a new RevokeAUserParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewRevokeAUserParamsWithTimeout added in v0.2.0 

func NewRevokeAUserParamsWithTimeout(timeout time.Duration) *RevokeAUserParams

NewRevokeAUserParamsWithTimeout creates a new RevokeAUserParams object with the default values initialized, and the ability to set a timeout on a request

func (*RevokeAUserParams) SetAuthInfoWriter added in v0.17.0 

func (o *RevokeAUserParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the revoke a user params

func (*RevokeAUserParams) SetContext added in v0.2.0 

func (o *RevokeAUserParams) SetContext(ctx context.Context)

SetContext adds the context to the revoke a user params

func (*RevokeAUserParams) SetHTTPClient added in v0.2.0 

func (o *RevokeAUserParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the revoke a user params

func (*RevokeAUserParams) SetHTTPClientTransport added in v0.19.0 

func (o *RevokeAUserParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the revoke a user params

func (*RevokeAUserParams) SetTimeout added in v0.2.0 

func (o *RevokeAUserParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the revoke a user params

func (*RevokeAUserParams) SetUserID added in v0.2.0 

func (o *RevokeAUserParams) SetUserID(userID string)

SetUserID adds the userId to the revoke a user params

func (*RevokeAUserParams) WithContext added in v0.2.0 

func (o *RevokeAUserParams) WithContext(ctx context.Context) *RevokeAUserParams

WithContext adds the context to the revoke a user params

func (*RevokeAUserParams) WithHTTPClient added in v0.2.0 

func (o *RevokeAUserParams) WithHTTPClient(client *http.Client) *RevokeAUserParams

WithHTTPClient adds the HTTPClient to the revoke a user params

func (*RevokeAUserParams) WithTimeout added in v0.2.0 

func (o *RevokeAUserParams) WithTimeout(timeout time.Duration) *RevokeAUserParams

WithTimeout adds the timeout to the revoke a user params

func (*RevokeAUserParams) WithUserID added in v0.2.0 

func (o *RevokeAUserParams) WithUserID(userID string) *RevokeAUserParams

WithUserID adds the userID to the revoke a user params

func (*RevokeAUserParams) WriteToRequest added in v0.2.0 

func (o *RevokeAUserParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type RevokeAUserReader added in v0.2.0 

type RevokeAUserReader struct {
	// contains filtered or unexported fields
}

RevokeAUserReader is a Reader for the RevokeAUser structure.

func (*RevokeAUserReader) ReadResponse added in v0.2.0 

func (o *RevokeAUserReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type RevokeAUserUnauthorized added in v0.2.0 

type RevokeAUserUnauthorized struct {
}

RevokeAUserUnauthorized handles this case with default header values. 

Invalid basic auth header

func NewRevokeAUserUnauthorized added in v0.2.0 

func NewRevokeAUserUnauthorized() *RevokeAUserUnauthorized

NewRevokeAUserUnauthorized creates a RevokeAUserUnauthorized with default headers values

func (*RevokeAUserUnauthorized) Error added in v0.2.0 

func (o *RevokeAUserUnauthorized) Error() string

type RevokeTokenBadRequest added in v0.2.0 

type RevokeTokenBadRequest struct {
}

RevokeTokenBadRequest handles this case with default header values. 

Invalid input

func NewRevokeTokenBadRequest added in v0.2.0 

func NewRevokeTokenBadRequest() *RevokeTokenBadRequest

NewRevokeTokenBadRequest creates a RevokeTokenBadRequest with default headers values

func (*RevokeTokenBadRequest) Error added in v0.2.0 

func (o *RevokeTokenBadRequest) Error() string

type RevokeTokenOK added in v0.2.0 

type RevokeTokenOK struct {
}

RevokeTokenOK handles this case with default header values. 

Token revoked or does not exist

func NewRevokeTokenOK added in v0.2.0 

func NewRevokeTokenOK() *RevokeTokenOK

NewRevokeTokenOK creates a RevokeTokenOK with default headers values

func (*RevokeTokenOK) Error added in v0.2.0 

func (o *RevokeTokenOK) Error() string

type RevokeTokenParams added in v0.2.0 

type RevokeTokenParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Token
	  Token to be revoked

	*/
	Token string

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client
	// contains filtered or unexported fields
}

RevokeTokenParams contains all the parameters to send to the API endpoint for the revoke token operation typically these are written to a http.Request

func NewRevokeTokenParams added in v0.2.0 

func NewRevokeTokenParams() *RevokeTokenParams

NewRevokeTokenParams creates a new RevokeTokenParams object with the default values initialized.

func NewRevokeTokenParamsWithContext added in v0.2.0 

func NewRevokeTokenParamsWithContext(ctx context.Context) *RevokeTokenParams

NewRevokeTokenParamsWithContext creates a new RevokeTokenParams object with the default values initialized, and the ability to set a context for a request

func NewRevokeTokenParamsWithHTTPClient added in v0.2.0 

func NewRevokeTokenParamsWithHTTPClient(client *http.Client) *RevokeTokenParams

NewRevokeTokenParamsWithHTTPClient creates a new RevokeTokenParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewRevokeTokenParamsWithTimeout added in v0.2.0 

func NewRevokeTokenParamsWithTimeout(timeout time.Duration) *RevokeTokenParams

NewRevokeTokenParamsWithTimeout creates a new RevokeTokenParams object with the default values initialized, and the ability to set a timeout on a request

func (*RevokeTokenParams) SetAuthInfoWriter added in v0.17.0 

func (o *RevokeTokenParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the revoke token params

func (*RevokeTokenParams) SetContext added in v0.2.0 

func (o *RevokeTokenParams) SetContext(ctx context.Context)

SetContext adds the context to the revoke token params

func (*RevokeTokenParams) SetHTTPClient added in v0.2.0 

func (o *RevokeTokenParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the revoke token params

func (*RevokeTokenParams) SetHTTPClientTransport added in v0.19.0 

func (o *RevokeTokenParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the revoke token params

func (*RevokeTokenParams) SetTimeout added in v0.2.0 

func (o *RevokeTokenParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the revoke token params

func (*RevokeTokenParams) SetToken added in v0.2.0 

func (o *RevokeTokenParams) SetToken(token string)

SetToken adds the token to the revoke token params

func (*RevokeTokenParams) WithContext added in v0.2.0 

func (o *RevokeTokenParams) WithContext(ctx context.Context) *RevokeTokenParams

WithContext adds the context to the revoke token params

func (*RevokeTokenParams) WithHTTPClient added in v0.2.0 

func (o *RevokeTokenParams) WithHTTPClient(client *http.Client) *RevokeTokenParams

WithHTTPClient adds the HTTPClient to the revoke token params

func (*RevokeTokenParams) WithTimeout added in v0.2.0 

func (o *RevokeTokenParams) WithTimeout(timeout time.Duration) *RevokeTokenParams

WithTimeout adds the timeout to the revoke token params

func (*RevokeTokenParams) WithToken added in v0.2.0 

func (o *RevokeTokenParams) WithToken(token string) *RevokeTokenParams

WithToken adds the token to the revoke token params

func (*RevokeTokenParams) WriteToRequest added in v0.2.0 

func (o *RevokeTokenParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type RevokeTokenReader added in v0.2.0 

type RevokeTokenReader struct {
	// contains filtered or unexported fields
}

RevokeTokenReader is a Reader for the RevokeToken structure.

func (*RevokeTokenReader) ReadResponse added in v0.2.0 

func (o *RevokeTokenReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type RevokeTokenUnauthorized added in v0.2.0 

type RevokeTokenUnauthorized struct {
}

RevokeTokenUnauthorized handles this case with default header values. 

Invalid basic auth header

func NewRevokeTokenUnauthorized added in v0.2.0 

func NewRevokeTokenUnauthorized() *RevokeTokenUnauthorized

NewRevokeTokenUnauthorized creates a RevokeTokenUnauthorized with default headers values

func (*RevokeTokenUnauthorized) Error added in v0.2.0 

func (o *RevokeTokenUnauthorized) Error() string

type RevokeUserOK added in v0.2.0 

type RevokeUserOK struct {
}

RevokeUserOK handles this case with default header values. 

User revoked

func NewRevokeUserOK added in v0.2.0 

func NewRevokeUserOK() *RevokeUserOK

NewRevokeUserOK creates a RevokeUserOK with default headers values

func (*RevokeUserOK) Error added in v0.2.0 

func (o *RevokeUserOK) Error() string

type RevokeUserParams added in v0.2.0 

type RevokeUserParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Namespace
	  namespace

	*/
	Namespace string
	/*UserID
	  User to be revoked

	*/
	UserID string

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client
	// contains filtered or unexported fields
}

RevokeUserParams contains all the parameters to send to the API endpoint for the revoke user operation typically these are written to a http.Request

func NewRevokeUserParams added in v0.2.0 

func NewRevokeUserParams() *RevokeUserParams

NewRevokeUserParams creates a new RevokeUserParams object with the default values initialized.

func NewRevokeUserParamsWithContext added in v0.2.0 

func NewRevokeUserParamsWithContext(ctx context.Context) *RevokeUserParams

NewRevokeUserParamsWithContext creates a new RevokeUserParams object with the default values initialized, and the ability to set a context for a request

func NewRevokeUserParamsWithHTTPClient added in v0.2.0 

func NewRevokeUserParamsWithHTTPClient(client *http.Client) *RevokeUserParams

NewRevokeUserParamsWithHTTPClient creates a new RevokeUserParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewRevokeUserParamsWithTimeout added in v0.2.0 

func NewRevokeUserParamsWithTimeout(timeout time.Duration) *RevokeUserParams

NewRevokeUserParamsWithTimeout creates a new RevokeUserParams object with the default values initialized, and the ability to set a timeout on a request

func (*RevokeUserParams) SetAuthInfoWriter added in v0.17.0 

func (o *RevokeUserParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the revoke user params

func (*RevokeUserParams) SetContext added in v0.2.0 

func (o *RevokeUserParams) SetContext(ctx context.Context)

SetContext adds the context to the revoke user params

func (*RevokeUserParams) SetHTTPClient added in v0.2.0 

func (o *RevokeUserParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the revoke user params

func (*RevokeUserParams) SetHTTPClientTransport added in v0.19.0 

func (o *RevokeUserParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the revoke user params

func (*RevokeUserParams) SetNamespace added in v0.2.0 

func (o *RevokeUserParams) SetNamespace(namespace string)

SetNamespace adds the namespace to the revoke user params

func (*RevokeUserParams) SetTimeout added in v0.2.0 

func (o *RevokeUserParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the revoke user params

func (*RevokeUserParams) SetUserID added in v0.2.0 

func (o *RevokeUserParams) SetUserID(userID string)

SetUserID adds the userId to the revoke user params

func (*RevokeUserParams) WithContext added in v0.2.0 

func (o *RevokeUserParams) WithContext(ctx context.Context) *RevokeUserParams

WithContext adds the context to the revoke user params

func (*RevokeUserParams) WithHTTPClient added in v0.2.0 

func (o *RevokeUserParams) WithHTTPClient(client *http.Client) *RevokeUserParams

WithHTTPClient adds the HTTPClient to the revoke user params

func (*RevokeUserParams) WithNamespace added in v0.2.0 

func (o *RevokeUserParams) WithNamespace(namespace string) *RevokeUserParams

WithNamespace adds the namespace to the revoke user params

func (*RevokeUserParams) WithTimeout added in v0.2.0 

func (o *RevokeUserParams) WithTimeout(timeout time.Duration) *RevokeUserParams

WithTimeout adds the timeout to the revoke user params

func (*RevokeUserParams) WithUserID added in v0.2.0 

func (o *RevokeUserParams) WithUserID(userID string) *RevokeUserParams

WithUserID adds the userID to the revoke user params

func (*RevokeUserParams) WriteToRequest added in v0.2.0 

func (o *RevokeUserParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type RevokeUserReader added in v0.2.0 

type RevokeUserReader struct {
	// contains filtered or unexported fields
}

RevokeUserReader is a Reader for the RevokeUser structure.

func (*RevokeUserReader) ReadResponse added in v0.2.0 

func (o *RevokeUserReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type RevokeUserUnauthorized added in v0.2.0 

type RevokeUserUnauthorized struct {
}

RevokeUserUnauthorized handles this case with default header values. 

Invalid basic auth header

func NewRevokeUserUnauthorized added in v0.2.0 

func NewRevokeUserUnauthorized() *RevokeUserUnauthorized

NewRevokeUserUnauthorized creates a RevokeUserUnauthorized with default headers values

func (*RevokeUserUnauthorized) Error added in v0.2.0 

func (o *RevokeUserUnauthorized) Error() string

type TokenGrantBadRequest 

type TokenGrantBadRequest struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

TokenGrantBadRequest handles this case with default header values. 

General request error

func NewTokenGrantBadRequest 

func NewTokenGrantBadRequest() *TokenGrantBadRequest

NewTokenGrantBadRequest creates a TokenGrantBadRequest with default headers values

func (*TokenGrantBadRequest) Error 

func (o *TokenGrantBadRequest) Error() string

func (*TokenGrantBadRequest) GetPayload 

func (o *TokenGrantBadRequest) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*TokenGrantBadRequest) ToJSONString added in v0.25.0 

func (o *TokenGrantBadRequest) ToJSONString() string

type TokenGrantOK 

type TokenGrantOK struct {
	Payload *iamclientmodels.OauthmodelTokenResponse
}

TokenGrantOK handles this case with default header values. 

Token returned

func NewTokenGrantOK 

func NewTokenGrantOK() *TokenGrantOK

NewTokenGrantOK creates a TokenGrantOK with default headers values

func (*TokenGrantOK) Error 

func (o *TokenGrantOK) Error() string

func (*TokenGrantOK) GetPayload 

func (o *TokenGrantOK) GetPayload() *iamclientmodels.OauthmodelTokenResponse

func (*TokenGrantOK) ToJSONString added in v0.25.0 

func (o *TokenGrantOK) ToJSONString() string

type TokenGrantParams 

type TokenGrantParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*DeviceID
	  DeviceID (Used on grant type 'password' to track login history) ex. 90252d14544846d79f367148e3f9a3d9

	*/
	DeviceID *string
	/*Code
	  Code (used with grant type 'authorization_code'

	*/
	Code *string
	/*ExtendExp
	  Extend expiration date of refresh token. Only available for grant type 'password'

	*/
	ExtendExp *bool
	/*Namespace
	  Delegated namespace (used with grant type 'password' to do token grant on other namespace)

	*/
	Namespace *string
	/*Password
	  Password (used with grant type 'password'

	*/
	Password *string
	/*RedirectURI
	  Redirect URI (used with grant type 'authorization_code'

	*/
	RedirectURI *string
	/*RefreshToken
	  Refresh Token (used with grant type 'refresh_token'

	*/
	RefreshToken *string
	/*Username
	  User Name (used with grant type 'password'

	*/
	Username *string
	/*GrantType
	  Grant Type

	*/
	GrantType string

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client
	// contains filtered or unexported fields
}

TokenGrantParams contains all the parameters to send to the API endpoint for the token grant operation typically these are written to a http.Request

func NewTokenGrantParams 

func NewTokenGrantParams() *TokenGrantParams

NewTokenGrantParams creates a new TokenGrantParams object with the default values initialized.

func NewTokenGrantParamsWithContext 

func NewTokenGrantParamsWithContext(ctx context.Context) *TokenGrantParams

NewTokenGrantParamsWithContext creates a new TokenGrantParams object with the default values initialized, and the ability to set a context for a request

func NewTokenGrantParamsWithHTTPClient 

func NewTokenGrantParamsWithHTTPClient(client *http.Client) *TokenGrantParams

NewTokenGrantParamsWithHTTPClient creates a new TokenGrantParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewTokenGrantParamsWithTimeout 

func NewTokenGrantParamsWithTimeout(timeout time.Duration) *TokenGrantParams

NewTokenGrantParamsWithTimeout creates a new TokenGrantParams object with the default values initialized, and the ability to set a timeout on a request

func (*TokenGrantParams) SetAuthInfoWriter added in v0.17.0 

func (o *TokenGrantParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the token grant params

func (*TokenGrantParams) SetCode 

func (o *TokenGrantParams) SetCode(code *string)

SetCode adds the code to the token grant params

func (*TokenGrantParams) SetContext 

func (o *TokenGrantParams) SetContext(ctx context.Context)

SetContext adds the context to the token grant params

func (*TokenGrantParams) SetDeviceID 

func (o *TokenGrantParams) SetDeviceID(deviceID *string)

SetDeviceID adds the deviceId to the token grant params

func (*TokenGrantParams) SetExtendExp 

func (o *TokenGrantParams) SetExtendExp(extendExp *bool)

SetExtendExp adds the extendExp to the token grant params

func (*TokenGrantParams) SetGrantType 

func (o *TokenGrantParams) SetGrantType(grantType string)

SetGrantType adds the grantType to the token grant params

func (*TokenGrantParams) SetHTTPClient 

func (o *TokenGrantParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the token grant params

func (*TokenGrantParams) SetHTTPClientTransport added in v0.19.0 

func (o *TokenGrantParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the token grant params

func (*TokenGrantParams) SetNamespace 

func (o *TokenGrantParams) SetNamespace(namespace *string)

SetNamespace adds the namespace to the token grant params

func (*TokenGrantParams) SetPassword 

func (o *TokenGrantParams) SetPassword(password *string)

SetPassword adds the password to the token grant params

func (*TokenGrantParams) SetRedirectURI 

func (o *TokenGrantParams) SetRedirectURI(redirectURI *string)

SetRedirectURI adds the redirectUri to the token grant params

func (*TokenGrantParams) SetRefreshToken 

func (o *TokenGrantParams) SetRefreshToken(refreshToken *string)

SetRefreshToken adds the refreshToken to the token grant params

func (*TokenGrantParams) SetTimeout 

func (o *TokenGrantParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the token grant params

func (*TokenGrantParams) SetUsername 

func (o *TokenGrantParams) SetUsername(username *string)

SetUsername adds the username to the token grant params

func (*TokenGrantParams) WithCode 

func (o *TokenGrantParams) WithCode(code *string) *TokenGrantParams

WithCode adds the code to the token grant params

func (*TokenGrantParams) WithContext 

func (o *TokenGrantParams) WithContext(ctx context.Context) *TokenGrantParams

WithContext adds the context to the token grant params

func (*TokenGrantParams) WithDeviceID 

func (o *TokenGrantParams) WithDeviceID(deviceID *string) *TokenGrantParams

WithDeviceID adds the deviceID to the token grant params

func (*TokenGrantParams) WithExtendExp 

func (o *TokenGrantParams) WithExtendExp(extendExp *bool) *TokenGrantParams

WithExtendExp adds the extendExp to the token grant params

func (*TokenGrantParams) WithGrantType 

func (o *TokenGrantParams) WithGrantType(grantType string) *TokenGrantParams

WithGrantType adds the grantType to the token grant params

func (*TokenGrantParams) WithHTTPClient 

func (o *TokenGrantParams) WithHTTPClient(client *http.Client) *TokenGrantParams

WithHTTPClient adds the HTTPClient to the token grant params

func (*TokenGrantParams) WithNamespace 

func (o *TokenGrantParams) WithNamespace(namespace *string) *TokenGrantParams

WithNamespace adds the namespace to the token grant params

func (*TokenGrantParams) WithPassword 

func (o *TokenGrantParams) WithPassword(password *string) *TokenGrantParams

WithPassword adds the password to the token grant params

func (*TokenGrantParams) WithRedirectURI 

func (o *TokenGrantParams) WithRedirectURI(redirectURI *string) *TokenGrantParams

WithRedirectURI adds the redirectURI to the token grant params

func (*TokenGrantParams) WithRefreshToken 

func (o *TokenGrantParams) WithRefreshToken(refreshToken *string) *TokenGrantParams

WithRefreshToken adds the refreshToken to the token grant params

func (*TokenGrantParams) WithTimeout 

func (o *TokenGrantParams) WithTimeout(timeout time.Duration) *TokenGrantParams

WithTimeout adds the timeout to the token grant params

func (*TokenGrantParams) WithUsername 

func (o *TokenGrantParams) WithUsername(username *string) *TokenGrantParams

WithUsername adds the username to the token grant params

func (*TokenGrantParams) WriteToRequest 

func (o *TokenGrantParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type TokenGrantReader 

type TokenGrantReader struct {
	// contains filtered or unexported fields
}

TokenGrantReader is a Reader for the TokenGrant structure.

func (*TokenGrantReader) ReadResponse 

func (o *TokenGrantReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type TokenGrantUnauthorized 

type TokenGrantUnauthorized struct {
	Payload *iamclientmodels.OauthmodelErrorResponse
}

TokenGrantUnauthorized handles this case with default header values. 

Client authentication failed

func NewTokenGrantUnauthorized 

func NewTokenGrantUnauthorized() *TokenGrantUnauthorized

NewTokenGrantUnauthorized creates a TokenGrantUnauthorized with default headers values

func (*TokenGrantUnauthorized) Error 

func (o *TokenGrantUnauthorized) Error() string

func (*TokenGrantUnauthorized) GetPayload 

func (o *TokenGrantUnauthorized) GetPayload() *iamclientmodels.OauthmodelErrorResponse

func (*TokenGrantUnauthorized) ToJSONString added in v0.25.0 

func (o *TokenGrantUnauthorized) ToJSONString() string

type VerifyTokenBadRequest added in v0.2.0 

type VerifyTokenBadRequest struct {
}

VerifyTokenBadRequest handles this case with default header values. 

Access Token not exist or expired

func NewVerifyTokenBadRequest added in v0.2.0 

func NewVerifyTokenBadRequest() *VerifyTokenBadRequest

NewVerifyTokenBadRequest creates a VerifyTokenBadRequest with default headers values

func (*VerifyTokenBadRequest) Error added in v0.2.0 

func (o *VerifyTokenBadRequest) Error() string

type VerifyTokenOK added in v0.2.0 

type VerifyTokenOK struct {
	Payload *iamclientmodels.OauthmodelTokenResponse
}

VerifyTokenOK handles this case with default header values. 

Access Token verified

func NewVerifyTokenOK added in v0.2.0 

func NewVerifyTokenOK() *VerifyTokenOK

NewVerifyTokenOK creates a VerifyTokenOK with default headers values

func (*VerifyTokenOK) Error added in v0.2.0 

func (o *VerifyTokenOK) Error() string

func (*VerifyTokenOK) GetPayload added in v0.2.0 

func (o *VerifyTokenOK) GetPayload() *iamclientmodels.OauthmodelTokenResponse

func (*VerifyTokenOK) ToJSONString added in v0.25.0 

func (o *VerifyTokenOK) ToJSONString() string

type VerifyTokenParams added in v0.2.0 

type VerifyTokenParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Token
	  Token to be verified

	*/
	Token string

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client
	// contains filtered or unexported fields
}

VerifyTokenParams contains all the parameters to send to the API endpoint for the verify token operation typically these are written to a http.Request

func NewVerifyTokenParams added in v0.2.0 

func NewVerifyTokenParams() *VerifyTokenParams

NewVerifyTokenParams creates a new VerifyTokenParams object with the default values initialized.

func NewVerifyTokenParamsWithContext added in v0.2.0 

func NewVerifyTokenParamsWithContext(ctx context.Context) *VerifyTokenParams

NewVerifyTokenParamsWithContext creates a new VerifyTokenParams object with the default values initialized, and the ability to set a context for a request

func NewVerifyTokenParamsWithHTTPClient added in v0.2.0 

func NewVerifyTokenParamsWithHTTPClient(client *http.Client) *VerifyTokenParams

NewVerifyTokenParamsWithHTTPClient creates a new VerifyTokenParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewVerifyTokenParamsWithTimeout added in v0.2.0 

func NewVerifyTokenParamsWithTimeout(timeout time.Duration) *VerifyTokenParams

NewVerifyTokenParamsWithTimeout creates a new VerifyTokenParams object with the default values initialized, and the ability to set a timeout on a request

func (*VerifyTokenParams) SetAuthInfoWriter added in v0.17.0 

func (o *VerifyTokenParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the verify token params

func (*VerifyTokenParams) SetContext added in v0.2.0 

func (o *VerifyTokenParams) SetContext(ctx context.Context)

SetContext adds the context to the verify token params

func (*VerifyTokenParams) SetHTTPClient added in v0.2.0 

func (o *VerifyTokenParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the verify token params

func (*VerifyTokenParams) SetHTTPClientTransport added in v0.19.0 

func (o *VerifyTokenParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the verify token params

func (*VerifyTokenParams) SetTimeout added in v0.2.0 

func (o *VerifyTokenParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the verify token params

func (*VerifyTokenParams) SetToken added in v0.2.0 

func (o *VerifyTokenParams) SetToken(token string)

SetToken adds the token to the verify token params

func (*VerifyTokenParams) WithContext added in v0.2.0 

func (o *VerifyTokenParams) WithContext(ctx context.Context) *VerifyTokenParams

WithContext adds the context to the verify token params

func (*VerifyTokenParams) WithHTTPClient added in v0.2.0 

func (o *VerifyTokenParams) WithHTTPClient(client *http.Client) *VerifyTokenParams

WithHTTPClient adds the HTTPClient to the verify token params

func (*VerifyTokenParams) WithTimeout added in v0.2.0 

func (o *VerifyTokenParams) WithTimeout(timeout time.Duration) *VerifyTokenParams

WithTimeout adds the timeout to the verify token params

func (*VerifyTokenParams) WithToken added in v0.2.0 

func (o *VerifyTokenParams) WithToken(token string) *VerifyTokenParams

WithToken adds the token to the verify token params

func (*VerifyTokenParams) WriteToRequest added in v0.2.0 

func (o *VerifyTokenParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type VerifyTokenReader added in v0.2.0 

type VerifyTokenReader struct {
	// contains filtered or unexported fields
}

VerifyTokenReader is a Reader for the VerifyToken structure.

func (*VerifyTokenReader) ReadResponse added in v0.2.0 

func (o *VerifyTokenReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.