# 查询所有SAML提供商 - ListSAMLProvidersV5 #### 功能介绍 该接口可以用于查询所有 SAML 2.0 的身份提供商 (IdP) 列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/IAM/doc?api=ListSAMLProvidersV5&version=v5)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-iam5/iam_02_1124.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | iam:samlProviders:listV5 | List | samlProvider \* | - | - | - | #### URI GET /v5/saml-providers 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释**： 每页显示的条目数量。 **约束限制**： 不涉及。 **取值范围**： 取值范围为\[1,200\]。 **默认取值**： 默认为100。 | | marker | 否 | String | **参数解释**： 服务内部自动生成的分页标记，用于标记本次请求的起始位置，可从上一次分页请求响应体的next_marker获得。 **约束限制**： 不涉及。 **取值范围**： 长度为4到400个字符，只包含字母、数字、"+"、"/"、"="、"-"和"_"的字符串。 **默认取值**： 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | saml_providers | Array of [saml_providers] objects | **参数解释**： SAML 提供商。 **取值范围**： 不涉及。 | | page_info | [page_info] object | **参数解释**： 分页信息。 **取值范围**： 不涉及。 | 表3saml_providers | 参数 | 参数类型 | 描述 | |:---|:---|:---| | provider_id | String | **参数解释**： SAML 身份提供商的ID。 **取值范围**： 字符串长度在 1 到 64 之间，并且只能包含：字母、数字、中划线（-）。 | | name | String | **参数解释**： SAML 身份提供商的名称。 **取值范围**： 字符串长度在 1 到 64 之间，并且只能包含：字母、数字、下划线（_）、中划线（-）。 | | description | String | **参数解释**： 身份提供商描述。 **取值范围**： 不能包含特定字符"@"、"#"、"%"、"\&"、"\<"、"\>"、""、"$"、"\^"和"\*"的字符串。 | | urn | String | **参数解释**： 统一资源名称。 **取值范围**： 字符串长度在 16 到 1500 之间，可以包含：字母、数字、斜杠（/）、等号（=）、下划线（_）、冒号（:）、中划线（-） | | saml_metadata_document | String | **参数解释**： 支持 SAML 2.0 的身份提供商 (IdP) 的 XML 文档。 **取值范围**： 长度范围为\[1000,512000\]个字符，必须为有效的XML格式。 | | assertion_encryption_mode | String | **参数解释**： 指定 SAML 身份提供商的加密设置。 **取值范围**： 取值范围为\[Required,Allowed\]。 - Required：仅接受加密的SAML断言。 - Allowed：接受加密或未加密的SAML断言。 | | private_keys | Array of [private_keys] objects | **参数解释**： 解密SAML断言的私钥对象列表，每个私钥对象包含key_id和timestamp字段。 **取值范围**： 列表元素数量取值范围为\[0,2\]个。 | | created_at | String | **参数解释**： SAML 身份提供商创建时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ，例如2023-09-13T06:51:20.550Z。 **取值范围**： 不涉及。 | | expires_at | String | **参数解释**： SAML 身份提供商过期时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ，例如2023-09-13T06:51:20.550Z。 **取值范围**： 不涉及。 | 表4private_keys | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key_id | String | **参数解释**： 解密 SAML 断言私钥的 ID。 **取值范围**： 不涉及。 | | timestamp | String | **参数解释**： 上传解密 SAML 断言私钥的时间，符合 ISO 8601 格式，例如：2024-01-01T12:00:00Z。 **取值范围**： 不涉及。 | 表5page_info | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | **参数解释**： 如果存在，则表示还有后续的条目未显示在当前返回体中。请使用该值作为下一次请求的分页标记参数以获得下一页信息。请反复调用该接口直至该字段不存在。 **取值范围**： 不涉及。 | | current_count | Integer | **参数解释**： 本页返回条目数量。 **取值范围**： 不涉及。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码，请参见[错误码](https://support.huaweicloud.com/api-iam5/ErrorCode.html)。 **取值范围**： 格式为PAP5.XXXX，例如 PAP5.0012。 | | error_msg | String | **参数解释**： 错误信息，请参见[错误信息](https://support.huaweicloud.com/api-iam5/ErrorCode.html)。 **取值范围**： 不涉及。 | | request_id | String | **参数解释**： API 请求的唯一标识，用于排查接口调用异常。 **取值范围**： 不涉及。 | **状态码：403** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码，请参见[错误码](https://support.huaweicloud.com/api-iam5/ErrorCode.html)。 **取值范围**： 格式为PAP5.XXXX，例如PAP5.0012。 | | error_msg | String | **参数解释**： 错误信息，请参见[错误信息](https://support.huaweicloud.com/api-iam5/ErrorCode.html)。 **取值范围**： 不涉及。 | | request_id | String | **参数解释**： API请求的唯一标识，用于排查接口调用异常。 **取值范围**： 不涉及。 | | encoded_authorization_message | String | **参数解释**： 认证失败时返回的加密详细信息，用于定位认证问题。 可以通过STS5解密接口进行解密，请参见[接口链接](https://support.huaweicloud.com/api-iam5/DecodeAuthorizationMessage.html)。 **取值范围**： 不涉及。 | #### 请求示例 无 #### 响应示例 **状态码：200** ``` { "saml_providers" : [ { "provider_id" : "example-saml-provider-id", "name" : "example_saml_provider", "urn" : "iam::123456789012:user:example-saml-user", "description" : "", "saml_metadata_document" : "\n\n\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\texample************************************************************************************************************************************************************************************************************************************************************************************************************************************************example\n\t\t\t\t\n\t\t\t\n\t\t\n\t\turn:oasis:names:tc:SAML:1.1:nameid-format:unspecified\n\t\turn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress\n\t\t\n\t\t\n\t\n", "assertion_encryption_mode" : "Allowed", "private_keys" : [ ], "created_at" : "2026-06-29T11:31:04.334Z", "expires_at" : "2126-06-05T11:31:04.221Z" } ], "page_info" : { "current_count" : 1 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功。 | | 400 | 请求体异常。 | | 403 | 没有操作权限。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-iam5/ErrorCode.html)。