GetIdentityProvider - 获取身份提供方

获取身份提供方。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eiam:GetIdentityProvider

get

*IdentityProvider

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

IdentityProviderId

string

身份提供方 ID。

idp_my664lwkhpicbyzirog3xxxxx

返回参数

名称

类型

描述

示例值

object

IdentityProviderDetail

object

身份提供商信息。

AdvancedStatus

string

高阶配置能力。取值范围:

  • 禁用:disabled

  • 启用:enabled

disabled

AuthnSourceSupplier

string

对应的认证来源产品,okta or google or azure ad。 取值范围:

  • 钉钉:urn:alibaba:idaas:idp:alibaba:dingtalk

  • LDAP:urn:alibaba:idaas:idp:unknown:ldap

  • 阿里云 IDaaS:urn:alibaba:idaas:idp:alibaba:idaas

  • 企业微信:urn:alibaba:idaas:idp:tencent:wecom

  • 飞书:urn:alibaba:idaas:idp:bytedance:lark

  • Active Directory:urn:alibaba:idaas:idp:microsoft:ad

  • Azure Active Directory:urn:alibaba:idaas:idp:microsoft:aad

  • 阿里云 SASE:urn:alibaba:idaas:idp:alibaba:sase

urn:alibaba:idaas:idp:bytedance:lark

AuthnSourceType

string

认证方式类型 oidc or saml,取值范围:

  • OIDC:urn:alibaba:idaas:authntype:oidc

  • SAML:urn:alibaba:idaas:authntype:saml2

urn:alibaba:idaas:authntype:oidc

AuthnStatus

string

对应 IdP 是否支持认证,取值范围:

  • 禁用:disabled

  • 启用:enabled

disabled

CreateTime

integer

创建时间,unix 时间戳,单位毫秒。

1726021079000

Description

string

身份提供方描述。

for poc test

DingtalkAppConfig

object

钉钉基础配置。

AppKey

string

钉钉一方应用的 appKey。

41reopmwoy9s

AppSecret

string

钉钉一方应用的 appSecret。

REOQ6Cl55kriOd8NOBeqWYLKpHR4p6fdZxxxx

CorpId

string

钉钉一方应用的 corpId。

3756043633237690761

DingtalkVersion

string

钉钉版本,取值范围:

  • 标准钉:public_dingtalk

  • 专属钉:private_dingtalk

public_dingtalk

EncryptKey

string

钉钉应用 EncryptKey

29003eb11d0a28b4802a6f02fb8aa25dff730e2ac26ffd200d

VerificationToken

string

钉钉应用 VerificationToken

5ba9c127a7abe029003eb11d0a28b4802a6f02fb8aa25dff730e2ac26ffd200d

DingtalkLoginVersion

string

IDaaS EIAM 钉钉扫码登录版本

DingtalkProvisioningConfig

object

钉钉同步配置,只有钉钉类型才会返回值。

AuthedDepartmentIds

array<object>

授权的钉钉部门。

object

DeptId

string

钉钉部门 ID。

123xxx444

DeptName

string

钉钉部门名称。

测试部门

AuthedUsers

array<object>

授权的钉钉账户列表。

object

Name

string

钉钉用户名称。

张三

UserId

string

钉钉用户 userId。

130308333929200479

CorpId

string

钉钉企业 corpId。

ding_xxxxx

CorpName

string

钉钉企业名称。

测试企业

IdentityProviderExternalId

string

身份提供方外部 ID。

idp_xxxx

IdentityProviderId

string

身份提供方 ID。

idp_mwpcwnhrimlr2horx7xgg7pp7y

IdentityProviderName

string

身份提供方名称。

test

IdentityProviderType

string

身份提供方同步类型。

  • 入方向钉钉:urn:alibaba:idaas:idp:alibaba:dingtalk:pull

  • 出方向钉钉:urn:alibaba:idaas:idp:alibaba:dingtalk:push

  • 入方向企业微信:urn:alibaba:idaas:idp:tencent:wecom:pull

  • 入方向飞书:urn:alibaba:idaas:idp:bytedance:lark:pull

  • 入方向 AD:urn:alibaba:idaas:idp:microsoft:ad:pull

  • 入方向 LDAP:urn:alibaba:idaas:idp:unknown:ldap:pull

  • 标准 OIDC:urn:alibaba:idaas:idp:standard:oidc

  • SASE 定制 OIDC:urn:alibaba:idaas:idp:alibaba:sase

urn:alibaba:idaas:idp:alibaba:dingtalk:push

InstanceId

string

实例 ID。

idaas_x2df3bak3uwnapqm6xxxx

LarkConfig

object

飞书配置。

AppId

string

飞书自建应用的 corpId。

cli_a7a99f53a317100c

AppSecret

string

飞书自建应用的 AppSecret。

***

EnterpriseNumber

string

飞书企业编码。

FX1231xxxx

EncryptKey

string

飞书自建应用的 encryptKey

VkdWw91mdkrjVFr3ObNwefap21dfbZbK

VerificationToken

string

飞书自建应用的 verificationToken

VkdWw91mdkrjVFr3ObNwefap21dfbZbK

LastStatusCheckJobResult

string

最后一次状态检查结果。

success

LdapConfig

object

AD/LDAP 身份提供方相关信息。

AdministratorPassword

string

AD/LDAP 管理员密码。

XXXX

AdministratorUsername

string

AD/LDAP 管理员账号。

example.com

CertificateFingerprintStatus

string

是否验证指纹证书,取值范围:

  • 禁用:disabled

  • 启用:enabled

enabled

CertificateFingerprints

array

证书指纹列表。

string

公钥 sha256 格式的证书指纹。

asdsadaasd

LdapProtocol

string

AD/LDAP 的通信协议。

ldap

LdapServerHost

string

AD/LDAP 服务器地址。

127.xx.xx.100

LdapServerPort

integer

AD/LDAP 服务器地址。

389

StartTlsStatus

string

startTLS 是否开启,取值范围:

  • 禁用:disabled

  • 启用:enabled

enabled

LockReason

string

锁定原因。

financial

NetworkAccessEndpointId

string

网络端点 ID。

nae_mx4vsadfe6govkqkwckxxxx

OidcConfig

object

OIDC IdP 配置。

AuthnParam

object

OIDC 客户端认证配置。

AuthnMethod

string

OIDC 认证方法。

client_secret_post

ClientId

string

OIDC 客户端 ID。

mkv7rgt4d7i4u7zqtzev2mxxxx

ClientSecret

string

OIDC 客户端密钥。

CSEHDddddddxxxxuxkJEHPveWRXBGqVqRsxxxx

EndpointConfig

object

OIDC 端点配置。

AuthorizationEndpoint

string

OIDC 授权端点。

https://example.com/oauth/authorize

Issuer

string

OIDC issuer 信息。

https://example.com/oauth

JwksUri

string

OIDC jwks 地址。

https://example.com/oauth/jwks

TokenEndpoint

string

OIDC Token 端点。

https://example.com/oauth/token

UserinfoEndpoint

string

OIDC 用户信息端点。

https://example.com/oauth/userinfo

GrantScopes

array

OIDC 授权范围列表。

openid

string

OIDC 授权范围。

ou_asdaq1addsxzdq1xxxx

GrantType

string

OIDC 授权类型。

authorization_code

PkceChallengeMethod

string

PKCE 算法,取值范围:

  • SHA256:S256

  • 明文:plain

S256

PkceRequired

boolean

AuthorizationCode 授权模式下是否使用 PKCE。

true

UdPullConfig

object

同步入配置。

GroupSyncStatus

string

是否开启组同步。取值范围:

  • 禁用:disabled

  • 启用:enabled

disabled

IncrementalCallbackStatus

string

增量回调状态,是否处理来自 IdP 的增量回调数据。取值范围:

  • 禁用:disabled

  • 启用:enabled

disabled

UdSyncScopeConfig

object

同步范围配置信息。

SourceScopes

array

同步来源节点列表。

string

同步来源节点。

ou_123xxxx

TargetScope

string

同步目标节点。

ou_123xxxx

UdPullStatus

string

是否支持同步入功能。取值范围:

  • 禁用:disabled

  • 启用:enabled

disabled

UdPushConfig

object

同步出配置。

IncrementalCallbackStatus

string

该字段暂未启用,请忽略。

disabled

UdSyncScopeConfigs

array<object>

同步范围配置列表。

object

同步范围配置列表。

SourceScopes

array

同步来源节点列表。

string

同步来源节点,填入组织 ID。

ou_123xxxx

TargetScope

string

同步目标节点。

ou_123xxxx

UdPushStatus

string

是否启用同步出能力。取值范围:

  • 禁用:disabled

  • 启用:enabled

disabled

UpdateTime

integer

更新时间,unix 时间戳,单位毫秒。

1726021079000

WeComConfig

object

企业微信配置信息。

AgentId

string

企业微信自建应用的 Id。

1242350

AuthorizeCallbackDomain

string

授权回调域。

https://example.com/xxxx

CorpId

string

企业微信自建应用的 corpId。

3562012953454577801

CorpSecret

string

企业微信自建应用的 corpSecret。

weaseiszjskejskaj12sjeszojxxxx

TrustableDomain

string

可信域名。

https://example.com

LogoUrl

string

身份提供商的自定义 Logo 地址

https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg

RequestId

string

请求 ID。

0441BD79-92F3-53AA-8657-F8CE4A2B912A

示例

正常返回示例

JSON格式

{
  "IdentityProviderDetail": {
    "AdvancedStatus": "disabled",
    "AuthnSourceSupplier": "urn:alibaba:idaas:idp:bytedance:lark",
    "AuthnSourceType": "urn:alibaba:idaas:authntype:oidc",
    "AuthnStatus": "disabled",
    "CreateTime": 1726021079000,
    "Description": "for poc test",
    "DingtalkAppConfig": {
      "AppKey": "41reopmwoy9s",
      "AppSecret": "REOQ6Cl55kriOd8NOBeqWYLKpHR4p6fdZxxxx",
      "CorpId": "3756043633237690761",
      "DingtalkVersion": "public_dingtalk",
      "EncryptKey": "29003eb11d0a28b4802a6f02fb8aa25dff730e2ac26ffd200d",
      "VerificationToken": "5ba9c127a7abe029003eb11d0a28b4802a6f02fb8aa25dff730e2ac26ffd200d",
      "DingtalkLoginVersion": ""
    },
    "DingtalkProvisioningConfig": {
      "AuthedDepartmentIds": [
        {
          "DeptId": "123xxx444",
          "DeptName": "测试部门"
        }
      ],
      "AuthedUsers": [
        {
          "Name": "张三",
          "UserId": "130308333929200479"
        }
      ],
      "CorpId": "ding_xxxxx",
      "CorpName": "测试企业"
    },
    "IdentityProviderExternalId": "idp_xxxx",
    "IdentityProviderId": "idp_mwpcwnhrimlr2horx7xgg7pp7y",
    "IdentityProviderName": "test",
    "IdentityProviderType": "urn:alibaba:idaas:idp:alibaba:dingtalk:push\n",
    "InstanceId": "idaas_x2df3bak3uwnapqm6xxxx",
    "LarkConfig": {
      "AppId": "cli_a7a99f53a317100c",
      "AppSecret": "***",
      "EnterpriseNumber": "FX1231xxxx",
      "EncryptKey": "VkdWw91mdkrjVFr3ObNwefap21dfbZbK",
      "VerificationToken": "VkdWw91mdkrjVFr3ObNwefap21dfbZbK"
    },
    "LastStatusCheckJobResult": "success",
    "LdapConfig": {
      "AdministratorPassword": "XXXX",
      "AdministratorUsername": "example.com",
      "CertificateFingerprintStatus": "enabled",
      "CertificateFingerprints": [
        "asdsadaasd"
      ],
      "LdapProtocol": "ldap",
      "LdapServerHost": "127.xx.xx.100",
      "LdapServerPort": 389,
      "StartTlsStatus": "enabled"
    },
    "LockReason": "financial",
    "NetworkAccessEndpointId": "nae_mx4vsadfe6govkqkwckxxxx",
    "OidcConfig": {
      "AuthnParam": {
        "AuthnMethod": "client_secret_post",
        "ClientId": "mkv7rgt4d7i4u7zqtzev2mxxxx",
        "ClientSecret": "CSEHDddddddxxxxuxkJEHPveWRXBGqVqRsxxxx"
      },
      "EndpointConfig": {
        "AuthorizationEndpoint": "https://example.com/oauth/authorize",
        "Issuer": "https://example.com/oauth",
        "JwksUri": "https://example.com/oauth/jwks",
        "TokenEndpoint": "https://example.com/oauth/token",
        "UserinfoEndpoint": "https://example.com/oauth/userinfo"
      },
      "GrantScopes": [
        "ou_asdaq1addsxzdq1xxxx"
      ],
      "GrantType": "authorization_code",
      "PkceChallengeMethod": "S256",
      "PkceRequired": true
    },
    "UdPullConfig": {
      "GroupSyncStatus": "disabled",
      "IncrementalCallbackStatus": "disabled",
      "UdSyncScopeConfig": {
        "SourceScopes": [
          "ou_123xxxx"
        ],
        "TargetScope": "ou_123xxxx"
      }
    },
    "UdPullStatus": "disabled",
    "UdPushConfig": {
      "IncrementalCallbackStatus": "disabled",
      "UdSyncScopeConfigs": [
        {
          "SourceScopes": [
            "ou_123xxxx"
          ],
          "TargetScope": "ou_123xxxx"
        }
      ]
    },
    "UdPushStatus": "disabled",
    "UpdateTime": 1726021079000,
    "WeComConfig": {
      "AgentId": "1242350",
      "AuthorizeCallbackDomain": "https://example.com/xxxx",
      "CorpId": "3562012953454577801",
      "CorpSecret": "weaseiszjskejskaj12sjeszojxxxx",
      "TrustableDomain": "https://example.com"
    },
    "LogoUrl": "https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg"
  },
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情