GetOAuthProvider - 查询 OAuth 身份提供商--访问控制-火山引擎

文档中心

立即注册

导航

GetOAuthProvider - 查询 OAuth 身份提供商

最近更新时间：2024.02.23 13:58:52首次发布时间：2024.02.23 13:58:52

查询 OAuth 身份提供商

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	GetOAuthProvider	要执行的操作，取值：GetOAuthProvider
Version	String	是	2018-01-01	API的版本，取值：2018-01-01
OAuthProviderName	String	是	my-provider	OAuth 身份提供商名称

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数	类型	示例值	描述
ProviderId	String	7236581599306055724	身份提供商 ID
Trn	String	trn:iam::2100000000:saml-provider/my-provider	身份提供商 Trn
OAuthProviderName	String	my-provider	OAuth 身份提供商名称
SSOType	Integer		身份提供商 SSO 类型角色 SSO 用户 SSO
Status	Integer		身份提供商状态 (仅用户 SSO) 开启开启并禁用其他登录方式关闭
CreateDate	String	2024-01-03T16:10:57+08:00	创建时间
UpdateDate	String	2024-01-03T16:10:57+08:00	更新时间
Description	String		身份提供商描述
ClientId	String		OAuth 应用 Client Id
ClientSecret	String		OAuth 授权应用秘钥
UserInfoURL	String		OAuth 授权服务用户信息端点地址
TokenURL	String		OAuth 授权服务 AccessToken 端点地址
AuthorizeURL	String		OAuth 授权服务授权地址
AuthorizeTemplate	String		OAuth 授权地址访问模板
Scope	String		OAuth 授权服务范围，多个使用空格连接
IdentityMapType	Integer		OAuth 用户信息映射子用户方式映射子用户名称映射子用户安全手机
IdpIdentityKey	String		OAauth 用户信息映射字段

请求示例

GET '/?Action=GetOAuthProvider&Version=2018-01-01&OAuthProviderName=oauth'

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202205191150550102252431470183A0D5",
        "Action": "GetOAuthProvider",
        "Version": "2018-01-01"
    },
    "Result": {
        "ProviderId": "7236581599306055724",
        "Trn": "trn:iam::2100054153:oauth-provider/oauth",
        "OAuthProviderName": "oauth",
        "SSOType": 2,
        "Status": 1,
        "ClientId": "*****",
        "ClientSecret": "*****",
        "UserInfoURL": "https://example.com/user_info",
        "TokenURL": "https://example.com/access_token",
        "IdentityMapType": 1,
        "IdpIdentityKey": "username",
        "CreateDate": "2023-06-05T14:43:31+08:00",
        "UpdateDate": "2024-01-03T17:32:25+08:00",
        "AuthorizeURL": "https://example.com/authorize",
        "AuthorizeTemplate": "${authEndpoint}?client_id=${clientId}&scope=${scope}&response_type=code&state=12345"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode	错误码	错误信息	说明
400	InvalidParameter	The specified parameter is invalid	接口参数不合法