v20240713

package
v3.0.1176+incompatible Latest Latest
Warning

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

Go to latest
Published: Apr 9, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const (

	// Operation failed.
	FAILEDOPERATION = "FailedOperation"

	// Parameter error.
	INVALIDPARAMETER = "InvalidParameter"

	// The IdP name is already in use.
	INVALIDPARAMETER_IDENTITYNAMEINUSE = "InvalidParameter.IdentityNameInUse"

	// IdP metadata document error.
	INVALIDPARAMETER_METADATAERROR = "InvalidParameter.MetadataError"

	// Parameter error.
	INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"

	// The OIDC signature public key is incorrect.
	INVALIDPARAMETERVALUE_IDENTITYKEYERROR = "InvalidParameterValue.IdentityKeyError"

	// The IdP URL is incorrect.
	INVALIDPARAMETERVALUE_IDENTITYURLERROR = "InvalidParameterValue.IdentityUrlError"

	// IdP name error.
	INVALIDPARAMETERVALUE_NAMEERROR = "InvalidParameterValue.NameError"

	// The upper limit on the number of IdPs has been reached.
	LIMITEXCEEDED_IDENTITYFULL = "LimitExceeded.IdentityFull"

	// The IdP does not exist.
	RESOURCENOTFOUND_IDENTITYNOTEXIST = "ResourceNotFound.IdentityNotExist"

	// No data.
	RESOURCENOTFOUND_RECORDNOTEXISTS = "ResourceNotFound.RecordNotExists"
)
View Source
const APIVersion = "2024-07-13"

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	common.Client
}

func NewClient

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) CreateIAPUserOIDCConfig

func (c *Client) CreateIAPUserOIDCConfig(request *CreateIAPUserOIDCConfigRequest) (response *CreateIAPUserOIDCConfigResponse, err error)

CreateIAPUserOIDCConfig This API is used to create a user OIDC configuration. Only one user OIDC IdP can be created, and the user SAML SSO IdP will be automatically disabled after it is created.

error code that may be returned:

INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_IDENTITYNAMEINUSE = "InvalidParameter.IdentityNameInUse"
INVALIDPARAMETER_METADATAERROR = "InvalidParameter.MetadataError"
INVALIDPARAMETERVALUE_IDENTITYKEYERROR = "InvalidParameterValue.IdentityKeyError"
INVALIDPARAMETERVALUE_IDENTITYURLERROR = "InvalidParameterValue.IdentityUrlError"
INVALIDPARAMETERVALUE_NAMEERROR = "InvalidParameterValue.NameError"
LIMITEXCEEDED_IDENTITYFULL = "LimitExceeded.IdentityFull"

func (*Client) CreateIAPUserOIDCConfigWithContext

func (c *Client) CreateIAPUserOIDCConfigWithContext(ctx context.Context, request *CreateIAPUserOIDCConfigRequest) (response *CreateIAPUserOIDCConfigResponse, err error)

CreateIAPUserOIDCConfig This API is used to create a user OIDC configuration. Only one user OIDC IdP can be created, and the user SAML SSO IdP will be automatically disabled after it is created.

error code that may be returned:

INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_IDENTITYNAMEINUSE = "InvalidParameter.IdentityNameInUse"
INVALIDPARAMETER_METADATAERROR = "InvalidParameter.MetadataError"
INVALIDPARAMETERVALUE_IDENTITYKEYERROR = "InvalidParameterValue.IdentityKeyError"
INVALIDPARAMETERVALUE_IDENTITYURLERROR = "InvalidParameterValue.IdentityUrlError"
INVALIDPARAMETERVALUE_NAMEERROR = "InvalidParameterValue.NameError"
LIMITEXCEEDED_IDENTITYFULL = "LimitExceeded.IdentityFull"

func (*Client) DescribeIAPLoginSessionDuration

func (c *Client) DescribeIAPLoginSessionDuration(request *DescribeIAPLoginSessionDurationRequest) (response *DescribeIAPLoginSessionDurationResponse, err error)

DescribeIAPLoginSessionDuration This API is used to query login session duration.

error code that may be returned:

INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
RESOURCENOTFOUND_RECORDNOTEXISTS = "ResourceNotFound.RecordNotExists"

func (*Client) DescribeIAPLoginSessionDurationWithContext

func (c *Client) DescribeIAPLoginSessionDurationWithContext(ctx context.Context, request *DescribeIAPLoginSessionDurationRequest) (response *DescribeIAPLoginSessionDurationResponse, err error)

DescribeIAPLoginSessionDuration This API is used to query login session duration.

error code that may be returned:

INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"
RESOURCENOTFOUND_RECORDNOTEXISTS = "ResourceNotFound.RecordNotExists"

func (*Client) DescribeIAPUserOIDCConfig

func (c *Client) DescribeIAPUserOIDCConfig(request *DescribeIAPUserOIDCConfigRequest) (response *DescribeIAPUserOIDCConfigResponse, err error)

DescribeIAPUserOIDCConfig This API is used to query a user OIDC configuration.

error code that may be returned:

RESOURCENOTFOUND_IDENTITYNOTEXIST = "ResourceNotFound.IdentityNotExist"

func (*Client) DescribeIAPUserOIDCConfigWithContext

func (c *Client) DescribeIAPUserOIDCConfigWithContext(ctx context.Context, request *DescribeIAPUserOIDCConfigRequest) (response *DescribeIAPUserOIDCConfigResponse, err error)

DescribeIAPUserOIDCConfig This API is used to query a user OIDC configuration.

error code that may be returned:

RESOURCENOTFOUND_IDENTITYNOTEXIST = "ResourceNotFound.IdentityNotExist"

func (*Client) DisableIAPUserSSO

func (c *Client) DisableIAPUserSSO(request *DisableIAPUserSSORequest) (response *DisableIAPUserSSOResponse, err error)

DisableIAPUserSSO This API is used to disable user SSO.

error code that may be returned:

INVALIDPARAMETER_METADATAERROR = "InvalidParameter.MetadataError"

func (*Client) DisableIAPUserSSOWithContext

func (c *Client) DisableIAPUserSSOWithContext(ctx context.Context, request *DisableIAPUserSSORequest) (response *DisableIAPUserSSOResponse, err error)

DisableIAPUserSSO This API is used to disable user SSO.

error code that may be returned:

INVALIDPARAMETER_METADATAERROR = "InvalidParameter.MetadataError"

func (*Client) ModifyIAPLoginSessionDuration

func (c *Client) ModifyIAPLoginSessionDuration(request *ModifyIAPLoginSessionDurationRequest) (response *ModifyIAPLoginSessionDurationResponse, err error)

ModifyIAPLoginSessionDuration This API is used to modify login session duration.

error code that may be returned:

INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"

func (*Client) ModifyIAPLoginSessionDurationWithContext

func (c *Client) ModifyIAPLoginSessionDurationWithContext(ctx context.Context, request *ModifyIAPLoginSessionDurationRequest) (response *ModifyIAPLoginSessionDurationResponse, err error)

ModifyIAPLoginSessionDuration This API is used to modify login session duration.

error code that may be returned:

INVALIDPARAMETER_PARAMERROR = "InvalidParameter.ParamError"

func (*Client) UpdateIAPUserOIDCConfig

func (c *Client) UpdateIAPUserOIDCConfig(request *UpdateIAPUserOIDCConfigRequest) (response *UpdateIAPUserOIDCConfigResponse, err error)

UpdateIAPUserOIDCConfig This API is used to modify a user OIDC configuration.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_IDENTITYNAMEINUSE = "InvalidParameter.IdentityNameInUse"
INVALIDPARAMETER_METADATAERROR = "InvalidParameter.MetadataError"
INVALIDPARAMETERVALUE_IDENTITYKEYERROR = "InvalidParameterValue.IdentityKeyError"
INVALIDPARAMETERVALUE_IDENTITYURLERROR = "InvalidParameterValue.IdentityUrlError"
LIMITEXCEEDED_IDENTITYFULL = "LimitExceeded.IdentityFull"
RESOURCENOTFOUND_IDENTITYNOTEXIST = "ResourceNotFound.IdentityNotExist"

func (*Client) UpdateIAPUserOIDCConfigWithContext

func (c *Client) UpdateIAPUserOIDCConfigWithContext(ctx context.Context, request *UpdateIAPUserOIDCConfigRequest) (response *UpdateIAPUserOIDCConfigResponse, err error)

UpdateIAPUserOIDCConfig This API is used to modify a user OIDC configuration.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_IDENTITYNAMEINUSE = "InvalidParameter.IdentityNameInUse"
INVALIDPARAMETER_METADATAERROR = "InvalidParameter.MetadataError"
INVALIDPARAMETERVALUE_IDENTITYKEYERROR = "InvalidParameterValue.IdentityKeyError"
INVALIDPARAMETERVALUE_IDENTITYURLERROR = "InvalidParameterValue.IdentityUrlError"
LIMITEXCEEDED_IDENTITYFULL = "LimitExceeded.IdentityFull"
RESOURCENOTFOUND_IDENTITYNOTEXIST = "ResourceNotFound.IdentityNotExist"

type CreateIAPUserOIDCConfigRequest

type CreateIAPUserOIDCConfigRequest struct {
	*tchttp.BaseRequest

	// OpenID Connect IdP URL. It corresponds to the value of the "issuer" field in the Openid-configuration provided by the enterprise IdP.
	IdentityUrl *string `json:"IdentityUrl,omitnil,omitempty" name:"IdentityUrl"`

	// Client ID registered with the OpenID Connect IdP.
	ClientId *string `json:"ClientId,omitnil,omitempty" name:"ClientId"`

	// OpenID Connect IdP authorization endpoint. It corresponds to the value of the "authorization_endpoint" field in the Openid-configuration provided by the enterprise IdP.
	AuthorizationEndpoint *string `json:"AuthorizationEndpoint,omitnil,omitempty" name:"AuthorizationEndpoint"`

	// Authorization response type, which is always id_token.
	ResponseType *string `json:"ResponseType,omitnil,omitempty" name:"ResponseType"`

	// Authorization response mode. Valid values: form_post (recommended); fragment.
	ResponseMode *string `json:"ResponseMode,omitnil,omitempty" name:"ResponseMode"`

	// Mapping field name. It indicates which field in the id_token of the IdP is mapped to the username of a sub-user. It is usually the sub or name field.
	MappingFiled *string `json:"MappingFiled,omitnil,omitempty" name:"MappingFiled"`

	// Signature public key, which is used to verify the OpenID Connect IdP's ID token and must be Base64-encoded. For the security of your account, we recommend you rotate it regularly.
	IdentityKey *string `json:"IdentityKey,omitnil,omitempty" name:"IdentityKey"`

	// Authorization information scope. Valid values: openid (default); email; profile.
	Scope []*string `json:"Scope,omitnil,omitempty" name:"Scope"`

	// Description
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`
}

func NewCreateIAPUserOIDCConfigRequest

func NewCreateIAPUserOIDCConfigRequest() (request *CreateIAPUserOIDCConfigRequest)

func (*CreateIAPUserOIDCConfigRequest) FromJsonString

func (r *CreateIAPUserOIDCConfigRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateIAPUserOIDCConfigRequest) ToJsonString

func (r *CreateIAPUserOIDCConfigRequest) ToJsonString() string

type CreateIAPUserOIDCConfigRequestParams

type CreateIAPUserOIDCConfigRequestParams struct {
	// OpenID Connect IdP URL. It corresponds to the value of the "issuer" field in the Openid-configuration provided by the enterprise IdP.
	IdentityUrl *string `json:"IdentityUrl,omitnil,omitempty" name:"IdentityUrl"`

	// Client ID registered with the OpenID Connect IdP.
	ClientId *string `json:"ClientId,omitnil,omitempty" name:"ClientId"`

	// OpenID Connect IdP authorization endpoint. It corresponds to the value of the "authorization_endpoint" field in the Openid-configuration provided by the enterprise IdP.
	AuthorizationEndpoint *string `json:"AuthorizationEndpoint,omitnil,omitempty" name:"AuthorizationEndpoint"`

	// Authorization response type, which is always id_token.
	ResponseType *string `json:"ResponseType,omitnil,omitempty" name:"ResponseType"`

	// Authorization response mode. Valid values: form_post (recommended); fragment.
	ResponseMode *string `json:"ResponseMode,omitnil,omitempty" name:"ResponseMode"`

	// Mapping field name. It indicates which field in the id_token of the IdP is mapped to the username of a sub-user. It is usually the sub or name field.
	MappingFiled *string `json:"MappingFiled,omitnil,omitempty" name:"MappingFiled"`

	// Signature public key, which is used to verify the OpenID Connect IdP's ID token and must be Base64-encoded. For the security of your account, we recommend you rotate it regularly.
	IdentityKey *string `json:"IdentityKey,omitnil,omitempty" name:"IdentityKey"`

	// Authorization information scope. Valid values: openid (default); email; profile.
	Scope []*string `json:"Scope,omitnil,omitempty" name:"Scope"`

	// Description
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`
}

Predefined struct for user

type CreateIAPUserOIDCConfigResponse

type CreateIAPUserOIDCConfigResponse struct {
	*tchttp.BaseResponse
	Response *CreateIAPUserOIDCConfigResponseParams `json:"Response"`
}

func NewCreateIAPUserOIDCConfigResponse

func NewCreateIAPUserOIDCConfigResponse() (response *CreateIAPUserOIDCConfigResponse)

func (*CreateIAPUserOIDCConfigResponse) FromJsonString

func (r *CreateIAPUserOIDCConfigResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateIAPUserOIDCConfigResponse) ToJsonString

func (r *CreateIAPUserOIDCConfigResponse) ToJsonString() string

type CreateIAPUserOIDCConfigResponseParams

type CreateIAPUserOIDCConfigResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeIAPLoginSessionDurationRequest

type DescribeIAPLoginSessionDurationRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeIAPLoginSessionDurationRequest

func NewDescribeIAPLoginSessionDurationRequest() (request *DescribeIAPLoginSessionDurationRequest)

func (*DescribeIAPLoginSessionDurationRequest) FromJsonString

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeIAPLoginSessionDurationRequest) ToJsonString

type DescribeIAPLoginSessionDurationRequestParams

type DescribeIAPLoginSessionDurationRequestParams struct {
}

Predefined struct for user

type DescribeIAPLoginSessionDurationResponse

type DescribeIAPLoginSessionDurationResponse struct {
	*tchttp.BaseResponse
	Response *DescribeIAPLoginSessionDurationResponseParams `json:"Response"`
}

func NewDescribeIAPLoginSessionDurationResponse

func NewDescribeIAPLoginSessionDurationResponse() (response *DescribeIAPLoginSessionDurationResponse)

func (*DescribeIAPLoginSessionDurationResponse) FromJsonString

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeIAPLoginSessionDurationResponse) ToJsonString

type DescribeIAPLoginSessionDurationResponseParams

type DescribeIAPLoginSessionDurationResponseParams struct {
	// Login session duration.
	Duration *int64 `json:"Duration,omitnil,omitempty" name:"Duration"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeIAPUserOIDCConfigRequest

type DescribeIAPUserOIDCConfigRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeIAPUserOIDCConfigRequest

func NewDescribeIAPUserOIDCConfigRequest() (request *DescribeIAPUserOIDCConfigRequest)

func (*DescribeIAPUserOIDCConfigRequest) FromJsonString

func (r *DescribeIAPUserOIDCConfigRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeIAPUserOIDCConfigRequest) ToJsonString

func (r *DescribeIAPUserOIDCConfigRequest) ToJsonString() string

type DescribeIAPUserOIDCConfigRequestParams

type DescribeIAPUserOIDCConfigRequestParams struct {
}

Predefined struct for user

type DescribeIAPUserOIDCConfigResponse

type DescribeIAPUserOIDCConfigResponse struct {
	*tchttp.BaseResponse
	Response *DescribeIAPUserOIDCConfigResponseParams `json:"Response"`
}

func NewDescribeIAPUserOIDCConfigResponse

func NewDescribeIAPUserOIDCConfigResponse() (response *DescribeIAPUserOIDCConfigResponse)

func (*DescribeIAPUserOIDCConfigResponse) FromJsonString

func (r *DescribeIAPUserOIDCConfigResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeIAPUserOIDCConfigResponse) ToJsonString

func (r *DescribeIAPUserOIDCConfigResponse) ToJsonString() string

type DescribeIAPUserOIDCConfigResponseParams

type DescribeIAPUserOIDCConfigResponseParams struct {
	// IdP type. 13: IAP user OIDC IdP.
	ProviderType *uint64 `json:"ProviderType,omitnil,omitempty" name:"ProviderType"`

	// IdP URL.
	IdentityUrl *string `json:"IdentityUrl,omitnil,omitempty" name:"IdentityUrl"`

	// Public key for signature.
	IdentityKey *string `json:"IdentityKey,omitnil,omitempty" name:"IdentityKey"`

	// Client ID.
	ClientId *string `json:"ClientId,omitnil,omitempty" name:"ClientId"`

	// Status. 0: Not set; 2: Disabled; 11: Enabled.
	Status *uint64 `json:"Status,omitnil,omitempty" name:"Status"`

	// The verification fingerprint of the HTTPS CA certificate. English letters and digits are allowed, and each fingerprint is 40 characters long, with a maximum of 5 fingerprints.
	Fingerprints []*string `json:"Fingerprints,omitnil,omitempty" name:"Fingerprints"`

	// Whether to enable the automatic use of the OIDC signature public key. 1: Yes, 2: No (default).
	EnableAutoPublicKey *uint64 `json:"EnableAutoPublicKey,omitnil,omitempty" name:"EnableAutoPublicKey"`

	// Authorization endpoint.
	AuthorizationEndpoint *string `json:"AuthorizationEndpoint,omitnil,omitempty" name:"AuthorizationEndpoint"`

	// Authorization scope.
	Scope []*string `json:"Scope,omitnil,omitempty" name:"Scope"`

	// Authorization response type.
	ResponseType *string `json:"ResponseType,omitnil,omitempty" name:"ResponseType"`

	// Authorization response mode.
	ResponseMode *string `json:"ResponseMode,omitnil,omitempty" name:"ResponseMode"`

	// Mapping field name.
	MappingFiled *string `json:"MappingFiled,omitnil,omitempty" name:"MappingFiled"`

	// Description
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DisableIAPUserSSORequest

type DisableIAPUserSSORequest struct {
	*tchttp.BaseRequest
}

func NewDisableIAPUserSSORequest

func NewDisableIAPUserSSORequest() (request *DisableIAPUserSSORequest)

func (*DisableIAPUserSSORequest) FromJsonString

func (r *DisableIAPUserSSORequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DisableIAPUserSSORequest) ToJsonString

func (r *DisableIAPUserSSORequest) ToJsonString() string

type DisableIAPUserSSORequestParams

type DisableIAPUserSSORequestParams struct {
}

Predefined struct for user

type DisableIAPUserSSOResponse

type DisableIAPUserSSOResponse struct {
	*tchttp.BaseResponse
	Response *DisableIAPUserSSOResponseParams `json:"Response"`
}

func NewDisableIAPUserSSOResponse

func NewDisableIAPUserSSOResponse() (response *DisableIAPUserSSOResponse)

func (*DisableIAPUserSSOResponse) FromJsonString

func (r *DisableIAPUserSSOResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DisableIAPUserSSOResponse) ToJsonString

func (r *DisableIAPUserSSOResponse) ToJsonString() string

type DisableIAPUserSSOResponseParams

type DisableIAPUserSSOResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ModifyIAPLoginSessionDurationRequest

type ModifyIAPLoginSessionDurationRequest struct {
	*tchttp.BaseRequest

	// Login session duration.
	Duration *int64 `json:"Duration,omitnil,omitempty" name:"Duration"`
}

func NewModifyIAPLoginSessionDurationRequest

func NewModifyIAPLoginSessionDurationRequest() (request *ModifyIAPLoginSessionDurationRequest)

func (*ModifyIAPLoginSessionDurationRequest) FromJsonString

func (r *ModifyIAPLoginSessionDurationRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyIAPLoginSessionDurationRequest) ToJsonString

func (r *ModifyIAPLoginSessionDurationRequest) ToJsonString() string

type ModifyIAPLoginSessionDurationRequestParams

type ModifyIAPLoginSessionDurationRequestParams struct {
	// Login session duration.
	Duration *int64 `json:"Duration,omitnil,omitempty" name:"Duration"`
}

Predefined struct for user

type ModifyIAPLoginSessionDurationResponse

type ModifyIAPLoginSessionDurationResponse struct {
	*tchttp.BaseResponse
	Response *ModifyIAPLoginSessionDurationResponseParams `json:"Response"`
}

func NewModifyIAPLoginSessionDurationResponse

func NewModifyIAPLoginSessionDurationResponse() (response *ModifyIAPLoginSessionDurationResponse)

func (*ModifyIAPLoginSessionDurationResponse) FromJsonString

func (r *ModifyIAPLoginSessionDurationResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyIAPLoginSessionDurationResponse) ToJsonString

type ModifyIAPLoginSessionDurationResponseParams

type ModifyIAPLoginSessionDurationResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type UpdateIAPUserOIDCConfigRequest

type UpdateIAPUserOIDCConfigRequest struct {
	*tchttp.BaseRequest

	// OpenID Connect IdP URL. It corresponds to the value of the "issuer" field in the Openid-configuration provided by the enterprise IdP.
	IdentityUrl *string `json:"IdentityUrl,omitnil,omitempty" name:"IdentityUrl"`

	// Client ID registered with the OpenID Connect IdP.
	ClientId *string `json:"ClientId,omitnil,omitempty" name:"ClientId"`

	// OpenID Connect IdP authorization endpoint. It corresponds to the value of the "authorization_endpoint" field in the Openid-configuration provided by the enterprise IdP.
	AuthorizationEndpoint *string `json:"AuthorizationEndpoint,omitnil,omitempty" name:"AuthorizationEndpoint"`

	// Authorization response type, which is always id_token.
	ResponseType *string `json:"ResponseType,omitnil,omitempty" name:"ResponseType"`

	// Authorization response mode. Valid values: form_post (recommended); fragment.
	ResponseMode *string `json:"ResponseMode,omitnil,omitempty" name:"ResponseMode"`

	// Mapping field name. It indicates which field in the id_token of the IdP is mapped to the username of a sub-user. It is usually the sub or name field.
	MappingFiled *string `json:"MappingFiled,omitnil,omitempty" name:"MappingFiled"`

	// RSA signature public key in the JWKS format, which is used to verify the OpenID Connect IdP's ID token and must be Base64-encoded. For the security of your account, we recommend you rotate it regularly.
	IdentityKey *string `json:"IdentityKey,omitnil,omitempty" name:"IdentityKey"`

	// Authorization information scope. Valid values: openid (default); email; profile.
	Scope []*string `json:"Scope,omitnil,omitempty" name:"Scope"`

	// Description, with a length of 1 to 255 English or Chinese characters. It is empty by default.
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`
}

func NewUpdateIAPUserOIDCConfigRequest

func NewUpdateIAPUserOIDCConfigRequest() (request *UpdateIAPUserOIDCConfigRequest)

func (*UpdateIAPUserOIDCConfigRequest) FromJsonString

func (r *UpdateIAPUserOIDCConfigRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateIAPUserOIDCConfigRequest) ToJsonString

func (r *UpdateIAPUserOIDCConfigRequest) ToJsonString() string

type UpdateIAPUserOIDCConfigRequestParams

type UpdateIAPUserOIDCConfigRequestParams struct {
	// OpenID Connect IdP URL. It corresponds to the value of the "issuer" field in the Openid-configuration provided by the enterprise IdP.
	IdentityUrl *string `json:"IdentityUrl,omitnil,omitempty" name:"IdentityUrl"`

	// Client ID registered with the OpenID Connect IdP.
	ClientId *string `json:"ClientId,omitnil,omitempty" name:"ClientId"`

	// OpenID Connect IdP authorization endpoint. It corresponds to the value of the "authorization_endpoint" field in the Openid-configuration provided by the enterprise IdP.
	AuthorizationEndpoint *string `json:"AuthorizationEndpoint,omitnil,omitempty" name:"AuthorizationEndpoint"`

	// Authorization response type, which is always id_token.
	ResponseType *string `json:"ResponseType,omitnil,omitempty" name:"ResponseType"`

	// Authorization response mode. Valid values: form_post (recommended); fragment.
	ResponseMode *string `json:"ResponseMode,omitnil,omitempty" name:"ResponseMode"`

	// Mapping field name. It indicates which field in the id_token of the IdP is mapped to the username of a sub-user. It is usually the sub or name field.
	MappingFiled *string `json:"MappingFiled,omitnil,omitempty" name:"MappingFiled"`

	// RSA signature public key in the JWKS format, which is used to verify the OpenID Connect IdP's ID token and must be Base64-encoded. For the security of your account, we recommend you rotate it regularly.
	IdentityKey *string `json:"IdentityKey,omitnil,omitempty" name:"IdentityKey"`

	// Authorization information scope. Valid values: openid (default); email; profile.
	Scope []*string `json:"Scope,omitnil,omitempty" name:"Scope"`

	// Description, with a length of 1 to 255 English or Chinese characters. It is empty by default.
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`
}

Predefined struct for user

type UpdateIAPUserOIDCConfigResponse

type UpdateIAPUserOIDCConfigResponse struct {
	*tchttp.BaseResponse
	Response *UpdateIAPUserOIDCConfigResponseParams `json:"Response"`
}

func NewUpdateIAPUserOIDCConfigResponse

func NewUpdateIAPUserOIDCConfigResponse() (response *UpdateIAPUserOIDCConfigResponse)

func (*UpdateIAPUserOIDCConfigResponse) FromJsonString

func (r *UpdateIAPUserOIDCConfigResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateIAPUserOIDCConfigResponse) ToJsonString

func (r *UpdateIAPUserOIDCConfigResponse) ToJsonString() string

type UpdateIAPUserOIDCConfigResponseParams

type UpdateIAPUserOIDCConfigResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL