jdcloud_sdk.services.ias.models package

Submodules

jdcloud_sdk.services.ias.models.AppQueryResultItem module

class jdcloud_sdk.services.ias.models.AppQueryResultItem.AppQueryResultItem(clientId=None, clientName=None, tokenEndpointAuthMethod=None, grantTypes=None, responseTypes=None, redirectUris=None, clientUri=None, logoUri=None, tosUri=None, policyUri=None, scope=None, jwksUri=None, jwks=None, contacts=None, extension=None, accessTokenValiditySeconds=None, refreshTokenValiditySeconds=None, multiTenant=None, secretUpdateTime=None, updateTime=None, createTime=None, account=None, userType=None, state=None)[source]

Bases: object

Parameters:
  • clientId – (Optional) 应用
  • clientName – (Optional) 应用名
  • tokenEndpointAuthMethod – (Optional) tokenEndpointAuthMethod
  • grantTypes – (Optional) grantTypes
  • responseTypes – (Optional) responseTypes
  • redirectUris – (Optional) redirectUris
  • clientUri – (Optional) clientUri
  • logoUri – (Optional) logoUri
  • tosUri – (Optional) tosUri
  • policyUri – (Optional) policyUri
  • scope – (Optional) scope
  • jwksUri – (Optional) jwksUri
  • jwks – (Optional) jwks
  • contacts – (Optional) contacts
  • extension – (Optional) extension
  • accessTokenValiditySeconds – (Optional) accessTokenValiditySeconds
  • refreshTokenValiditySeconds – (Optional) refreshTokenValiditySeconds
  • multiTenant – (Optional) multiTenant
  • secretUpdateTime – (Optional) secretUpdateTime
  • updateTime – (Optional) updateTime
  • createTime – (Optional) createTime
  • account – (Optional) account
  • userType – (Optional) userType
  • state – (Optional) state

jdcloud_sdk.services.ias.models.Application module

class jdcloud_sdk.services.ias.models.Application.Application(clientName=None, tokenEndpointAuthMethod=None, grantTypes=None, redirectUris=None, clientUri=None, logoUri=None, tosUri=None, policyUri=None, scope=None, jwksUri=None, jwks=None, contacts=None, extension=None, accessTokenValiditySeconds=None, refreshTokenValiditySeconds=None, multiTenant=None, secret=None, userType=None)[source]

Bases: object

Parameters:
  • clientName – (Optional) 应用名
  • tokenEndpointAuthMethod – (Optional) 客户端认证方式<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
  • grantTypes – (Optional) 支持的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设置
  • redirectUris – (Optional) 回调地址，最多4个，多个url之间用逗号,分隔，每个url长度不超过1000，url不支持#符号
  • clientUri – (Optional) 应用介绍地址，url不支持#符号
  • logoUri – (Optional) 应用logo地址，url不支持#符号
  • tosUri – (Optional) 应用服务协议地址，url不支持#符号
  • policyUri – (Optional) 应用隐私政策地址，url不支持#符号
  • scope – (Optional) OAuth scope范围，支持的值为：<br/> （1）openid：用OpenID Connect协议进行身份认证<br/> 指定scope为openid，并在Authorization Endpoint请求该scope，京东云将返回用户的OpenID令牌；如果在创建应用时未指明该值，则应用不能请求OpenID令牌；任何时候应用都可以调用“更新应用”更改该设置
  • jwksUri – (Optional) JWKS地址，url不支持#符号<br/>jwksUri和jwks传一个即可
  • jwks – (Optional) JWKS
  • contacts – (Optional) 应用联系信息
  • extension – (Optional) 应用扩展信息
  • accessTokenValiditySeconds – (Optional) 访问令牌有效期，值的范围为 600 秒到 6x3600=21,600 秒，即10分钟-6小时
  • refreshTokenValiditySeconds – (Optional) 刷新令牌有效期，值的范围为 30x24x3600=2,592,000 秒到 365x24x3600=31,536,000 秒，即30天-365天<br/><br/> 注：当 GrantTypes 包含 refresh_token 时，refreshTokenValiditySeconds 为必传参数
  • multiTenant – (Optional) 是否为多租户应用<br/> “false”：该应用仅支持当前创建应用的租户访问，其他京东云租户无法访问<br/> “true”：该应用支持其他京东云租户访问，但当前创建应用的租户不能访问
  • secret – (Optional) 应用的密码，支持8-255位长度的ASCII可打印字符，建议使用足够复杂的密码策略<br/><br/> 注：当TokenEndpointAuthMethod不等于none时，secret为必传参数；反之，当指定了secret时，TokenEndpointAuthMethod不能等于none<br/>京东云将不可逆加密secret，因此您无法再次从京东云查看该密码，但您可以随时通过更新应用重新设置secret
  • userType – (Optional) 能访问应用的账号类型，支持以下值：<br/> （1）root：支持主账号访问，子用户无法访问<br/> （2）sub：子用户账号，使用主账号不能访问<br/><br/> 注：multiTenant和userType的组合指定了应用的用户人群，典型的应用场景如：<br/> （1）应用向当前租户下的子用户开放（2）应用向京东云其他租户主账号开放

jdcloud_sdk.services.ias.models.ApplicationRes module

class jdcloud_sdk.services.ias.models.ApplicationRes.ApplicationRes(clientId, clientName, tokenEndpointAuthMethod, grantTypes, responseTypes, redirectUris, clientUri, logoUri, tosUri, policyUri, scope, jwksUri, jwks, contacts, extension, accessTokenValiditySeconds, refreshTokenValiditySeconds, multiTenant, secretUpdateTime, updateTime, createTime, account, userType)[source]

Bases: object

Parameters:
  • clientId – 应用ID，由京东云分配的16位数字ID
  • clientName – 应用名
  • tokenEndpointAuthMethod – 客户端认证方式
  • grantTypes – 支持的OAuth类型
  • responseTypes – 当grantTypes为authorization_code时，responseTypes为code；当grantTypes为implicit时，responseTypes为token
  • redirectUris – 回调地址
  • clientUri – 应用介绍地址
  • logoUri – 应用logo地址
  • tosUri – 应用服务协议地址
  • policyUri – 应用隐私条款地址
  • scope – OAuth scope授权范围
  • jwksUri – JWKS地址
  • jwks – JWKS
  • contacts – 应用联系信息
  • extension – 应用扩展信息
  • accessTokenValiditySeconds – 访问令牌有效期
  • refreshTokenValiditySeconds – 刷新令牌有效期
  • multiTenant – 是否为多租户应用
  • secretUpdateTime – 应用密码更新时间
  • updateTime – 应用更新时间
  • createTime – 应用创建时间
  • account – 创建应用的账户用户名
  • userType – 允许登录应用的账号类型

jdcloud_sdk.services.ias.models.Pagination module

class jdcloud_sdk.services.ias.models.Pagination.Pagination(currPageNo=None, numberPages=None, numberRecords=None, pageSize=None, startIndex=None)[source]

Bases: object

Parameters:
  • currPageNo – (Optional) currPageNo
  • numberPages – (Optional) numberPages
  • numberRecords – (Optional) numberRecords
  • pageSize – (Optional) pageSize
  • startIndex – (Optional) startIndex

jdcloud_sdk.services.ias.models.State module

class jdcloud_sdk.services.ias.models.State.State(label=None, value=None)[source]

Bases: object

Parameters:
  • label – (Optional) label
  • value – (Optional) value

jdcloud_sdk.services.ias.models.UpdateApplication module

class jdcloud_sdk.services.ias.models.UpdateApplication.UpdateApplication(clientName=None, tokenEndpointAuthMethod=None, grantTypes=None, redirectUris=None, clientUri=None, logoUri=None, tosUri=None, policyUri=None, scope=None, jwksUri=None, jwks=None, contacts=None, extension=None, accessTokenValiditySeconds=None, refreshTokenValiditySeconds=None, multiTenant=None, secret=None, userType=None)[source]

Bases: object

Parameters:
  • clientName – (Optional) 应用名
  • tokenEndpointAuthMethod – (Optional) 客户端认证方式：<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
  • grantTypes – (Optional) 支持的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设置
  • redirectUris – (Optional) 回调地址，最多4个，多个url之间用逗号,分隔，每个url长度不超过1000，url不支持#符号
  • clientUri – (Optional) 应用介绍地址，url不支持#符号
  • logoUri – (Optional) 应用logo地址，url不支持#符号
  • tosUri – (Optional) 应用服务协议地址，url不支持#符号
  • policyUri – (Optional) 应用隐私政策地址，url不支持#符号
  • scope – (Optional) OAuth scope范围，支持的值为：<br/> （1）openid：用OpenID Connect协议进行身份认证<br/> 指定scope为openid，并在Authorization Endpoint请求该scope，京东云将返回用户的OpenID令牌；如果在创建应用时未指明该值，则应用不能请求OpenID令牌；任何时候应用都可以调用“更新应用”更改该设置
  • jwksUri – (Optional) JWKS地址，url不支持#符号<br/> jwksUri和jwks传一个即可
  • jwks – (Optional) JWKS
  • contacts – (Optional) 应用联系信息
  • extension – (Optional) 应用扩展信息
  • accessTokenValiditySeconds – (Optional) 访问令牌有效期，值的范围为 600 秒到 6x3600=21,600 秒，即10分钟-6小时
  • refreshTokenValiditySeconds – (Optional) 刷新令牌有效期，值的范围为 30x24x3600=2,592,000 秒到 365x24x3600=31,536,000 秒，即30天-365天<br/><br/> 注：当 GrantTypes 包含 refresh_token 时，refreshTokenValiditySeconds 为必传参数
  • multiTenant – (Optional) 是否为多租户应用<br/> “false”：该应用仅支持当前创建应用的租户访问，其他京东云租户无法访问<br/> “true”：该应用支持其他京东云租户访问，但当前创建应用的租户不能访问
  • secret – (Optional) 应用的密码，支持8-255位长度的ASCII可打印字符，建议使用足够复杂的密码策略<br/><br/> 注：当TokenEndpointAuthMethod不等于none时，secret为必传参数；反之，当指定了secret时，TokenEndpointAuthMethod不能等于none<br/> 京东云将不可逆加密secret，因此您无法再次从京东云查看该密码，但您可以随时通过更新应用重新设置secret
  • userType – (Optional) 能访问应用的账号类型，支持以下值：<br/> （1）root：支持主账号访问，子用户无法访问<br/> （2）sub：子用户账号，使用主账号不能访问<br/><br/> 注：multiTenant和userType的组合指定了应用的用户人群，典型的应用场景如：<br/> （1）应用向当前租户下的子用户开放（2）应用向京东云其他租户主账号开放

Module contents