Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppQueryResultItem ¶ added in v1.1.3
type AppQueryResultItem struct {
/* 应用 (Optional) */
ClientId string `json:"clientId"`
/* 应用名 (Optional) */
ClientName string `json:"clientName"`
/* tokenEndpointAuthMethod (Optional) */
TokenEndpointAuthMethod string `json:"tokenEndpointAuthMethod"`
/* grantTypes (Optional) */
GrantTypes string `json:"grantTypes"`
/* responseTypes (Optional) */
ResponseTypes string `json:"responseTypes"`
/* redirectUris (Optional) */
RedirectUris string `json:"redirectUris"`
/* clientUri (Optional) */
ClientUri string `json:"clientUri"`
/* logoUri (Optional) */
LogoUri string `json:"logoUri"`
/* tosUri (Optional) */
TosUri string `json:"tosUri"`
/* policyUri (Optional) */
PolicyUri string `json:"policyUri"`
/* scope (Optional) */
Scope string `json:"scope"`
/* jwksUri (Optional) */
JwksUri string `json:"jwksUri"`
/* jwks (Optional) */
Jwks string `json:"jwks"`
/* contacts (Optional) */
Contacts string `json:"contacts"`
/* extension (Optional) */
Extension string `json:"extension"`
/* accessTokenValiditySeconds (Optional) */
AccessTokenValiditySeconds int `json:"accessTokenValiditySeconds"`
/* refreshTokenValiditySeconds (Optional) */
RefreshTokenValiditySeconds int `json:"refreshTokenValiditySeconds"`
/* multiTenant (Optional) */
MultiTenant bool `json:"multiTenant"`
/* secretUpdateTime (Optional) */
SecretUpdateTime int64 `json:"secretUpdateTime"`
/* updateTime (Optional) */
UpdateTime int64 `json:"updateTime"`
/* createTime (Optional) */
CreateTime int64 `json:"createTime"`
/* account (Optional) */
Account string `json:"account"`
/* userType (Optional) */
UserType string `json:"userType"`
/* state (Optional) */
State string `json:"state"`
}
type Application ¶
type Application struct {
/* 应用名 (Optional) */
ClientName string `json:"clientName"`
/* 客户端认证方式<br> - none:不设置客户端密码(不推荐)<br> - client_secret_post:客户端必须设置密码,且该密码需要在OAuth2 Token Endpoint提供于请求的body<br> - client_secret_basic:客户端必须设置密码,且该密码需要在OAuth2 Token Endpoint提供于请求的header<br> 支持以下值:<br> (1)none<br> (2)client_secret_post<br> (3)client_secret_basic (Optional) */
TokenEndpointAuthMethod string `json:"tokenEndpointAuthMethod"`
/* 支持的OAuth类型:<br> - authorization_code:OAuth2授权码模式<br> - implicit:OAuth2隐式授权模式<br> - refresh_token:启用刷新令牌 支持以下值:<br> (1)authorization_code<br> (2)authorization_code,refresh_token<br> (3)authorization_code,implicit<br> (4)authorization_code,implicit,refresh_token<br> (5)implicit<br> 注:如果grantTypes指定了refresh_token,应用将可以使用刷新令牌;如果在创建应用时未指定,则应用不能使用刷新令牌;任何时候应用都可以调用“更新应用”接口更改grantTypes设置 (Optional) */
GrantTypes string `json:"grantTypes"`
/* 回调地址,最多4个,多个url之间用逗号,分隔,每个url长度不超过1000,url不支持#符号 (Optional) */
RedirectUris string `json:"redirectUris"`
/* 应用介绍地址,url不支持#符号 (Optional) */
ClientUri string `json:"clientUri"`
/* 应用logo地址,url不支持#符号 (Optional) */
LogoUri string `json:"logoUri"`
/* 应用服务协议地址,url不支持#符号 (Optional) */
TosUri string `json:"tosUri"`
/* 应用隐私政策地址,url不支持#符号 (Optional) */
PolicyUri string `json:"policyUri"`
/* OAuth scope范围,支持的值为:<br/> (1)openid:用OpenID Connect协议进行身份认证<br/> 指定scope为openid,并在Authorization Endpoint请求该scope,京东云将返回用户的OpenID令牌;如果在创建应用时未指明该值,则应用不能请求OpenID令牌;任何时候应用都可以调用“更新应用”更改该设置 (Optional) */
Scope string `json:"scope"`
/* JWKS地址,url不支持#符号<br/>jwksUri和jwks传一个即可 (Optional) */
JwksUri string `json:"jwksUri"`
/* JWKS (Optional) */
Jwks string `json:"jwks"`
/* 应用联系信息 (Optional) */
Contacts string `json:"contacts"`
/* 应用扩展信息 (Optional) */
Extension string `json:"extension"`
/* 访问令牌有效期,值的范围为 600 秒到 6x3600=21,600 秒,即10分钟-6小时 (Optional) */
AccessTokenValiditySeconds int `json:"accessTokenValiditySeconds"`
/* 刷新令牌有效期,值的范围为 30x24x3600=2,592,000 秒到 365x24x3600=31,536,000 秒,即30天-365天<br/><br/> 注:当 GrantTypes 包含 refresh_token 时,refreshTokenValiditySeconds 为必传参数 (Optional) */
RefreshTokenValiditySeconds int `json:"refreshTokenValiditySeconds"`
/* 是否为多租户应用<br/> "false":该应用仅支持当前创建应用的租户访问,其他京东云租户无法访问<br/> "true":该应用支持其他京东云租户访问,但当前创建应用的租户不能访问 (Optional) */
MultiTenant bool `json:"multiTenant"`
/* 应用的密码,支持8-255位长度的ASCII可打印字符,建议使用足够复杂的密码策略<br/><br/> 注:当TokenEndpointAuthMethod不等于none时,secret为必传参数;反之,当指定了secret时,TokenEndpointAuthMethod不能等于none<br/>京东云将不可逆加密secret,因此您无法再次从京东云查看该密码,但您可以随时通过更新应用重新设置secret (Optional) */
Secret string `json:"secret"`
/* 能访问应用的账号类型,支持以下值:<br/> (1)root:支持主账号访问,子用户无法访问<br/> (2)sub:子用户账号,使用主账号不能访问<br/><br/> 注:multiTenant和userType的组合指定了应用的用户人群,典型的应用场景如:<br/> (1)应用向当前租户下的子用户开放(2)应用向京东云其他租户主账号开放 (Optional) */
UserType string `json:"userType"`
}
type ApplicationRes ¶
type ApplicationRes struct {
/* 应用ID,由京东云分配的16位数字ID */
ClientId string `json:"clientId"`
/* 应用名 */
ClientName string `json:"clientName"`
/* 客户端认证方式 */
TokenEndpointAuthMethod string `json:"tokenEndpointAuthMethod"`
/* 支持的OAuth类型 */
GrantTypes string `json:"grantTypes"`
/* 当grantTypes为authorization_code时,responseTypes为code;当grantTypes为implicit时,responseTypes为token */
ResponseTypes string `json:"responseTypes"`
/* 回调地址 */
RedirectUris string `json:"redirectUris"`
/* 应用介绍地址 */
ClientUri string `json:"clientUri"`
/* 应用logo地址 */
LogoUri string `json:"logoUri"`
/* 应用服务协议地址 */
TosUri string `json:"tosUri"`
/* 应用隐私条款地址 */
PolicyUri string `json:"policyUri"`
/* OAuth scope授权范围 */
Scope string `json:"scope"`
/* JWKS地址 */
JwksUri string `json:"jwksUri"`
/* JWKS */
Jwks string `json:"jwks"`
/* 应用联系信息 */
Contacts string `json:"contacts"`
/* 应用扩展信息 */
Extension string `json:"extension"`
/* 访问令牌有效期 */
AccessTokenValiditySeconds int `json:"accessTokenValiditySeconds"`
/* 刷新令牌有效期 */
RefreshTokenValiditySeconds int `json:"refreshTokenValiditySeconds"`
/* 是否为多租户应用 */
MultiTenant bool `json:"multiTenant"`
/* 应用密码更新时间 */
SecretUpdateTime int64 `json:"secretUpdateTime"`
/* 应用更新时间 */
UpdateTime int64 `json:"updateTime"`
/* 应用创建时间 */
CreateTime int64 `json:"createTime"`
/* 创建应用的账户用户名 */
Account string `json:"account"`
/* 允许登录应用的账号类型 */
UserType string `json:"userType"`
}
type Pagination ¶ added in v1.1.3
type Pagination struct {
/* currPageNo (Optional) */
CurrPageNo int `json:"currPageNo"`
/* numberPages (Optional) */
NumberPages int `json:"numberPages"`
/* numberRecords (Optional) */
NumberRecords int `json:"numberRecords"`
/* pageSize (Optional) */
PageSize int `json:"pageSize"`
/* startIndex (Optional) */
StartIndex int `json:"startIndex"`
}
type UpdateApplication ¶ added in v1.1.3
type UpdateApplication struct {
/* 应用名 (Optional) */
ClientName string `json:"clientName"`
/* 客户端认证方式:<br/> none:不设置客户端密码(不推荐)<br/> client_secret_post:客户端必须设置密码,且该密码需要在OAuth2 Token Endpoint提供于请求的body<br/> client_secret_basic:客户端必须设置密码,且该密码需要在OAuth2 Token Endpoint提供于请求的header<br/><br/> 支持以下值:<br/> (1)none<br/> (2)client_secret_post<br/> (3)client_secret_basic (Optional) */
TokenEndpointAuthMethod string `json:"tokenEndpointAuthMethod"`
/* 支持的OAuth类型:<br/> authorization_code:OAuth2授权码模式<br/> implicit:OAuth2隐式授权模式<br/> refresh_token:启用刷新令牌<br/><br/> 支持以下值:<br/> (1)authorization_code<br/> (2)authorization_code,refresh_token<br/> (3)authorization_code,implicit<br/> (4)authorization_code,implicit,refresh_token<br/> (5)implicit<br/><br/> 注:如果grantTypes指定了refresh_token,应用将可以使用刷新令牌;如果在创建应用时未指定,则应用不能使用刷新令牌;任何时候应用都可以调用“更新应用”接口更改grantTypes设置 (Optional) */
GrantTypes string `json:"grantTypes"`
/* 回调地址,最多4个,多个url之间用逗号,分隔,每个url长度不超过1000,url不支持#符号 (Optional) */
RedirectUris string `json:"redirectUris"`
/* 应用介绍地址,url不支持#符号 (Optional) */
ClientUri string `json:"clientUri"`
/* 应用logo地址,url不支持#符号 (Optional) */
LogoUri string `json:"logoUri"`
/* 应用服务协议地址,url不支持#符号 (Optional) */
TosUri string `json:"tosUri"`
/* 应用隐私政策地址,url不支持#符号 (Optional) */
PolicyUri string `json:"policyUri"`
/* OAuth scope范围,支持的值为:<br/> (1)openid:用OpenID Connect协议进行身份认证<br/> 指定scope为openid,并在Authorization Endpoint请求该scope,京东云将返回用户的OpenID令牌;如果在创建应用时未指明该值,则应用不能请求OpenID令牌;任何时候应用都可以调用“更新应用”更改该设置 (Optional) */
Scope string `json:"scope"`
/* JWKS地址,url不支持#符号<br/> jwksUri和jwks传一个即可 (Optional) */
JwksUri string `json:"jwksUri"`
/* JWKS (Optional) */
Jwks string `json:"jwks"`
/* 应用联系信息 (Optional) */
Contacts string `json:"contacts"`
/* 应用扩展信息 (Optional) */
Extension string `json:"extension"`
/* 访问令牌有效期,值的范围为 600 秒到 6x3600=21,600 秒,即10分钟-6小时 (Optional) */
AccessTokenValiditySeconds int `json:"accessTokenValiditySeconds"`
/* 刷新令牌有效期,值的范围为 30x24x3600=2,592,000 秒到 365x24x3600=31,536,000 秒,即30天-365天<br/><br/> 注:当 GrantTypes 包含 refresh_token 时,refreshTokenValiditySeconds 为必传参数 (Optional) */
RefreshTokenValiditySeconds int `json:"refreshTokenValiditySeconds"`
/* 是否为多租户应用<br/> "false":该应用仅支持当前创建应用的租户访问,其他京东云租户无法访问<br/> "true":该应用支持其他京东云租户访问,但当前创建应用的租户不能访问 (Optional) */
MultiTenant bool `json:"multiTenant"`
/* 应用的密码,支持8-255位长度的ASCII可打印字符,建议使用足够复杂的密码策略<br/><br/> 注:当TokenEndpointAuthMethod不等于none时,secret为必传参数;反之,当指定了secret时,TokenEndpointAuthMethod不能等于none<br/> 京东云将不可逆加密secret,因此您无法再次从京东云查看该密码,但您可以随时通过更新应用重新设置secret (Optional) */
Secret string `json:"secret"`
/* 能访问应用的账号类型,支持以下值:<br/> (1)root:支持主账号访问,子用户无法访问<br/> (2)sub:子用户账号,使用主账号不能访问<br/><br/> 注:multiTenant和userType的组合指定了应用的用户人群,典型的应用场景如:<br/> (1)应用向当前租户下的子用户开放(2)应用向京东云其他租户主账号开放 (Optional) */
UserType string `json:"userType"`
}
Click to show internal directories.
Click to hide internal directories.