vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/iam/api-ref/CLASS.TXT.json
weihongmin1 ca9b774f3d IAM API 1108 Version 
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: weihongmin1 <weihongmin1@huawei.com>
Co-committed-by: weihongmin1 <weihongmin1@huawei.com>
2024-12-03 20:42:07 +00:00

1631 lines
64 KiB
JSON
Raw Blame History

[
{
"desc":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ",
"product_code":"iam",
"title":"API Usage Guidelines",
"uri":"iam_02_0017.html",
"doc_type":"api",
"p_code":"",
"code":"1"
},
{
"desc":"Welcome to Identity and Access Management (IAM). IAM provides identity authentication, permissions management, and access control. With IAM, you can create and manage use",
"product_code":"iam",
"title":"Before You Start",
"uri":"en-us_topic_0057845582.html",
"doc_type":"api",
"p_code":"",
"code":"2"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"API Overview",
"uri":"iam_01_0008.html",
"doc_type":"api",
"p_code":"",
"code":"3"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Calling APIs",
"uri":"iam_02_0000.html",
"doc_type":"api",
"p_code":"",
"code":"4"
},
{
"desc":"This section describes the structure of a REST API request, and uses the IAM API for obtaining a user token (see Obtaining a User Token) as an example to demonstrate how ",
"product_code":"iam",
"title":"Making an API Request",
"uri":"iam_02_0008.html",
"doc_type":"api",
"p_code":"4",
"code":"5"
},
{
"desc":"Requests for calling an API can be authenticated using either of the following methods:Token-based authentication: Requests are authenticated using a token.AK/SK-based au",
"product_code":"iam",
"title":"Authentication",
"uri":"iam_02_0510.html",
"doc_type":"api",
"p_code":"4",
"code":"6"
},
{
"desc":"After sending a request, you will receive a response, including the status code, response header, and response body.A status code is a group of digits, ranging from 1xx t",
"product_code":"iam",
"title":"Response",
"uri":"iam_02_0511.html",
"doc_type":"api",
"p_code":"4",
"code":"7"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"APIs",
"uri":"iam_20_0000.html",
"doc_type":"api",
"p_code":"",
"code":"8"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Token Management",
"uri":"en-us_topic_0057845626.html",
"doc_type":"api",
"p_code":"8",
"code":"9"
},
{
"desc":"This API is used to obtain a token through username/password authentication. A token is a system object encapsulating the identity and permissions of a user. When calling",
"product_code":"iam",
"title":"Obtaining a User Token",
"uri":"en-us_topic_0057845583.html",
"doc_type":"api",
"p_code":"9",
"code":"10"
},
{
"desc":"This API is used to obtain an agency token. For example, after a trust relationship is established between A (delegating party) and B (delegated party), the delegated par",
"product_code":"iam",
"title":"Obtaining an Agency Token",
"uri":"en-us_topic_0064274720.html",
"doc_type":"api",
"p_code":"9",
"code":"11"
},
{
"desc":"This API is used to check the validity of a specified token. If the token is valid, detailed information about the token will be returned.GET /v3/auth/tokensParameters in",
"product_code":"iam",
"title":"Verifying a Token and Returning a Valid Token",
"uri":"en-us_topic_0057845585.html",
"doc_type":"api",
"p_code":"9",
"code":"12"
},
{
"desc":"This API can be used by the administrator to verify the token of a user or used by a user to verify their token. The administrator can only verify the token of a user cre",
"product_code":"iam",
"title":"Verifying a Token",
"uri":"en-us_topic_0057845586.html",
"doc_type":"api",
"p_code":"9",
"code":"13"
},
{
"desc":"This API is used to delete a token no matter whether the token has expired or not.DELETE /v3/auth/tokensParameters in the request headerParameterMandatoryTypeDescriptionX",
"product_code":"iam",
"title":"Deleting a User Token",
"uri":"iam_02_0063.html",
"doc_type":"api",
"p_code":"9",
"code":"14"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Access Key Management",
"uri":"en-us_topic_0097942776.html",
"doc_type":"api",
"p_code":"8",
"code":"15"
},
{
"desc":"You can obtain a temporary AK/SK and security token (offline AK/SK) by using a user token, agency token, and federated token. A temporary AK/SK is a token with temporary ",
"product_code":"iam",
"title":"Obtaining a Temporary AK/SK",
"uri":"en-us_topic_0097949518.html",
"doc_type":"api",
"p_code":"15",
"code":"16"
},
{
"desc":"This API can be used by the administrator to create a permanent access key for an IAM user or used by an IAM user to create a permanent access key for itself.Access keys ",
"product_code":"iam",
"title":"Creating a Permanent Access Key",
"uri":"iam_03_0001.html",
"doc_type":"api",
"p_code":"15",
"code":"17"
},
{
"desc":"This API can be used by the administrator to list all permanent access key of an IAM user or used by an IAM user to list all of their permanent access keys.The API can be",
"product_code":"iam",
"title":"Listing Permanent Access Keys",
"uri":"iam_03_0003.html",
"doc_type":"api",
"p_code":"15",
"code":"18"
},
{
"desc":"This API can be used by the administrator to query the specified permanent access key of an IAM user or used by an IAM user to query one of their permanent access keys.Th",
"product_code":"iam",
"title":"Querying a Permanent Access Key",
"uri":"iam_03_0002.html",
"doc_type":"api",
"p_code":"15",
"code":"19"
},
{
"desc":"This API can be used by the administrator to modify the specified permanent access key of an IAM user or used by an IAM user to modify one of their permanent access keys.",
"product_code":"iam",
"title":"Modifying a Permanent Access Key",
"uri":"iam_03_0004.html",
"doc_type":"api",
"p_code":"15",
"code":"20"
},
{
"desc":"This API can be used by the administrator to delete the specified permanent access key of an IAM user or used by an IAM user to delete one of their permanent access keys.",
"product_code":"iam",
"title":"Deleting a Permanent Access Key",
"uri":"iam_03_0005.html",
"doc_type":"api",
"p_code":"15",
"code":"21"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Region Management",
"uri":"en-us_topic_0067148042.html",
"doc_type":"api",
"p_code":"8",
"code":"22"
},
{
"desc":"This API is used to query a region list.GET /v3/regionsParameters in the request headerParameterMandatoryTypeDescriptionContent-TypeYesStringFill application/json;charset",
"product_code":"iam",
"title":"Querying a Region List",
"uri":"en-us_topic_0067148043.html",
"doc_type":"api",
"p_code":"22",
"code":"23"
},
{
"desc":"This API is used to query region details.URI formatGET /v3/regions/{region_id}GET /v3/regions/{region_id}URI parametersParameterMandatoryTypeDescriptionregion_idYesString",
"product_code":"iam",
"title":"Querying Region Details",
"uri":"en-us_topic_0067148044.html",
"doc_type":"api",
"p_code":"22",
"code":"24"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Project Management",
"uri":"en-us_topic_0057845642.html",
"doc_type":"api",
"p_code":"8",
"code":"25"
},
{
"desc":"This API is used to query project information based on the specified criteria.URI formatGET /v3/projects{?domain_id,name,enabled,parent_id,is_domain,page,per_page}GET /v3",
"product_code":"iam",
"title":"Querying Project Information Based on the Specified Criteria",
"uri":"en-us_topic_0057845625.html",
"doc_type":"api",
"p_code":"25",
"code":"26"
},
{
"desc":"This API is used to query the project list of a specified user.URI formatGET /v3/users/{user_id}/projectsGET /v3/users/{user_id}/projectsURI parametersParameterMandatoryT",
"product_code":"iam",
"title":"Querying a User Project List",
"uri":"en-us_topic_0057845622.html",
"doc_type":"api",
"p_code":"25",
"code":"27"
},
{
"desc":"This API is used to query the list of projects accessible to users.GET /v3/auth/projectsParameters in the request headerParameterMandatoryTypeDescriptionContent-TypeYesSt",
"product_code":"iam",
"title":"Querying the List of Projects Accessible to Users",
"uri":"en-us_topic_0057845558.html",
"doc_type":"api",
"p_code":"25",
"code":"28"
},
{
"desc":"This API is used to create a project.POST /v3/projectsParameters in the request headerParameterMandatoryTypeDescriptionContent-TypeYesStringFill application/json;charset=",
"product_code":"iam",
"title":"Creating a Project",
"uri":"en-us_topic_0066154565.html",
"doc_type":"api",
"p_code":"25",
"code":"29"
},
{
"desc":"This API is used to modify project information.URI formatPATCH /v3/projects/{project_id}PATCH /v3/projects/{project_id}URI parametersParameterMandatoryTypeDescriptionproj",
"product_code":"iam",
"title":"Modifying Project Data",
"uri":"en-us_topic_0066154566.html",
"doc_type":"api",
"p_code":"25",
"code":"30"
},
{
"desc":"This API is used to query detailed information about a project based on the project ID.URI formatGET /v3/projects/{project_id}GET /v3/projects/{project_id}URI parametersP",
"product_code":"iam",
"title":"Querying Information About a Specified Project",
"uri":"en-us_topic_0066154567.html",
"doc_type":"api",
"p_code":"25",
"code":"31"
},
{
"desc":"This API is used to set the status of a specified project. The project statuses include Normal and Suspended.URI formatPUT /v3-ext/projects/{project_id}PUT /v3-ext/projec",
"product_code":"iam",
"title":"Setting the Status of a Specified Project",
"uri":"en-us_topic_0074171149.html",
"doc_type":"api",
"p_code":"25",
"code":"32"
},
{
"desc":"This API is used to query details about a specified project, including the project status.URI formatGET /v3-ext/projects/{project_id}GET /v3-ext/projects/{project_id}URI ",
"product_code":"iam",
"title":"Querying Information and Status of a Specified Project",
"uri":"en-us_topic_0079466135.html",
"doc_type":"api",
"p_code":"25",
"code":"33"
},
{
"desc":"This API is used to delete a project.URI formatDELETE /v3/projects/{project_id}DELETE /v3/projects/{project_id}URI parametersParameterMandatoryTypeDescriptionproject_idYe",
"product_code":"iam",
"title":"Deleting a Project",
"uri":"en-us_topic_0094012960.html",
"doc_type":"api",
"p_code":"25",
"code":"34"
},
{
"desc":"This API is used to query the quotas of a specified project.URI formatGET /v3.0/OS-QUOTA/projects/{project_id}GET /v3.0/OS-QUOTA/projects/{project_id}URI parametersStatus",
"product_code":"iam",
"title":"Querying the Quotas of a Project",
"uri":"iam_02_0037.html",
"doc_type":"api",
"p_code":"25",
"code":"35"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Tenant Management",
"uri":"en-us_topic_0057845621.html",
"doc_type":"api",
"p_code":"8",
"code":"36"
},
{
"desc":"This API is used to query the list of domains accessible to users.GET /v3/auth/domainsParameters in the request headerParameterMandatoryTypeDescriptionX-Auth-TokenYesStri",
"product_code":"iam",
"title":"Querying the List of Domains Accessible to Users",
"uri":"en-us_topic_0057845574.html",
"doc_type":"api",
"p_code":"36",
"code":"37"
},
{
"desc":"This API is used to query the password strength policy, including its regular expression and description.URI formatGET /v3/domains/{domain_id}/config/security_complianceG",
"product_code":"iam",
"title":"Querying the Password Strength Policy",
"uri":"iam_02_0007.html",
"doc_type":"api",
"p_code":"36",
"code":"38"
},
{
"desc":"This API is used to query the password strength policy by option. The option can be the regular expression and description of the password strength policy.URI formatGET /",
"product_code":"iam",
"title":"Querying the Password Strength Policy by Option",
"uri":"iam_02_0113.html",
"doc_type":"api",
"p_code":"36",
"code":"39"
},
{
"desc":"This API is used to query a resource quota. You can query the quota of users, user groups, identity providers, agencies, and policies.URI formatGET /v3.0/OS-QUOTA/domains",
"product_code":"iam",
"title":"Querying a Resource Quota",
"uri":"iam_02_0114.html",
"doc_type":"api",
"p_code":"36",
"code":"40"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"User Management",
"uri":"en-us_topic_0057845593.html",
"doc_type":"api",
"p_code":"8",
"code":"41"
},
{
"desc":"This API is used to query a user list.URI formatGET /v3/usersGET /v3/usersURI parametersParameterMandatoryTypeDescriptiondomain_idNoStringID of the domain that a user bel",
"product_code":"iam",
"title":"Querying a User List",
"uri":"en-us_topic_0057845638.html",
"doc_type":"api",
"p_code":"41",
"code":"42"
},
{
"desc":"This API is used to query detailed information about a specified user.URI formatGET /v3/users/{user_id}GET /v3/users/{user_id}URI parametersParameterMandatoryTypeDescript",
"product_code":"iam",
"title":"Querying User Details",
"uri":"en-us_topic_0057845652.html",
"doc_type":"api",
"p_code":"41",
"code":"43"
},
{
"desc":"This API can be used by the administrator to query the details about a specified user or used by a user to query their details.GET /v3.0/OS-USER/users/{user_id}Status cod",
"product_code":"iam",
"title":"Querying User Details (Recommended)",
"uri":"iam_08_0004.html",
"doc_type":"api",
"p_code":"41",
"code":"44"
},
{
"desc":"This API is used to query the information about the user group to which a specified user belongs.URI formatGET /v3/users/{user_id}/groupsGET /v3/users/{user_id}/groupsURI",
"product_code":"iam",
"title":"Querying the User Group to Which a User Belongs",
"uri":"en-us_topic_0057845554.html",
"doc_type":"api",
"p_code":"41",
"code":"45"
},
{
"desc":"This API is used to query users in a user group.URI formatGET /v3/groups/{group_id}/usersGET /v3/groups/{group_id}/usersURI parametersParameterMandatoryTypeDescriptiongro",
"product_code":"iam",
"title":"Querying Users in a User Group",
"uri":"en-us_topic_0057845561.html",
"doc_type":"api",
"p_code":"41",
"code":"46"
},
{
"desc":"This API is provided for the administrator to create an IAM user.POST /v3.0/OS-USER/usersRequest for an administrator to create an IAM user named IAMUser, with the email ",
"product_code":"iam",
"title":"Creating an IAM User (Recommended)",
"uri":"iam_08_0015.html",
"doc_type":"api",
"p_code":"41",
"code":"47"
},
{
"desc":"This API is used to create a user under a domain.POST /v3/usersParameters in the request headerParameterMandatoryTypeDescriptionContent-TypeYesStringFill application/json",
"product_code":"iam",
"title":"Creating a User",
"uri":"en-us_topic_0057845637.html",
"doc_type":"api",
"p_code":"41",
"code":"48"
},
{
"desc":"This API is used to change the password for a user.URI formatPOST /v3/users/{user_id}/passwordPOST /v3/users/{user_id}/passwordURI parametersParameterMandatoryTypeDescrip",
"product_code":"iam",
"title":"Changing a Password",
"uri":"en-us_topic_0057845653.html",
"doc_type":"api",
"p_code":"41",
"code":"49"
},
{
"desc":"This API is used to modify user information under a domain.URI formatPATCH /v3/users/{user_id}PATCH /v3/users/{user_id}URI parametersParameterMandatoryTypeDescriptionuser",
"product_code":"iam",
"title":"Modifying User Information",
"uri":"en-us_topic_0057845611.html",
"doc_type":"api",
"p_code":"41",
"code":"50"
},
{
"desc":"This API is provided for the administrator to modify user information.PUT /v3.0/OS-USER/users/{user_id}Status code: 200The request is successful.",
"product_code":"iam",
"title":"Modifying User Information (Including Email Address and Mobile Number) as the Administrator",
"uri":"iam_08_0011.html",
"doc_type":"api",
"p_code":"41",
"code":"51"
},
{
"desc":"This API is used to delete a user.URI formatDELETE /v3/users/{user_id}DELETE /v3/users/{user_id}URI parametersParameterMandatoryTypeDescriptionuser_idYesStringUser ID.Par",
"product_code":"iam",
"title":"Deleting a User",
"uri":"en-us_topic_0057845630.html",
"doc_type":"api",
"p_code":"41",
"code":"52"
},
{
"desc":"This API is used to delete a user from a user group.URI formatDELETE /v3/groups/{group_id}/users/{user_id}DELETE /v3/groups/{group_id}/users/{user_id}URI parametersParame",
"product_code":"iam",
"title":"Deleting a User from a User Group",
"uri":"en-us_topic_0057845601.html",
"doc_type":"api",
"p_code":"41",
"code":"53"
},
{
"desc":"This API is used by the administrator to send a welcome email to a user.The welcome email contains a one-time password-free login link, which can be used by the user to s",
"product_code":"iam",
"title":"Sending a Welcome Email to a User",
"uri":"iam_08_0025.html",
"doc_type":"api",
"p_code":"41",
"code":"54"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"User Group Management",
"uri":"en-us_topic_0057845641.html",
"doc_type":"api",
"p_code":"8",
"code":"55"
},
{
"desc":"This API is used to query user group information.URI formatGET /v3/groups{?domain_id,name}GET /v3/groups{?domain_id,name}Query parametersParameterMandatoryTypeDescription",
"product_code":"iam",
"title":"Listing User Groups",
"uri":"en-us_topic_0057845602.html",
"doc_type":"api",
"p_code":"55",
"code":"56"
},
{
"desc":"This API is used to query detailed information about a user group.URI formatGET /v3/groups/{group_id}GET /v3/groups/{group_id}Query parametersParameterMandatoryTypeDescri",
"product_code":"iam",
"title":"Querying User Group Details",
"uri":"en-us_topic_0057845618.html",
"doc_type":"api",
"p_code":"55",
"code":"57"
},
{
"desc":"This API is used to create a user group.POST /v3/groupsParameters in the request headerParameterMandatoryTypeDescriptionContent-TypeYesStringFill application/json;charset",
"product_code":"iam",
"title":"Creating a User Group",
"uri":"en-us_topic_0057845650.html",
"doc_type":"api",
"p_code":"55",
"code":"58"
},
{
"desc":"This API is used to add a user to a user group.URI formatPUT /v3/groups/{group_id}/users/{user_id}PUT /v3/groups/{group_id}/users/{user_id}URI parametersParameterMandator",
"product_code":"iam",
"title":"Adding a User to a User Group",
"uri":"en-us_topic_0057845654.html",
"doc_type":"api",
"p_code":"55",
"code":"59"
},
{
"desc":"This API is used to update user group information.URI formatPATCH /v3/groups/{group_id}PATCH /v3/groups/{group_id}URI parametersParameterMandatoryTypeDescriptiongroup_idY",
"product_code":"iam",
"title":"Updating a User Group",
"uri":"en-us_topic_0057845600.html",
"doc_type":"api",
"p_code":"55",
"code":"60"
},
{
"desc":"This API is used to delete a user group.URI formatDELETE /v3/groups/{group_id}DELETE /v3/groups/{group_id}URI parametersParameterMandatoryTypeDescriptiongroup_idYesString",
"product_code":"iam",
"title":"Deleting a User Group",
"uri":"en-us_topic_0057845566.html",
"doc_type":"api",
"p_code":"55",
"code":"61"
},
{
"desc":"This API is used to query whether a user belongs to a user group.URI formatHEAD /v3/groups/{group_id}/users/{user_id}HEAD /v3/groups/{group_id}/users/{user_id}URI paramet",
"product_code":"iam",
"title":"Querying Whether a User Belongs to a User Group",
"uri":"en-us_topic_0057845599.html",
"doc_type":"api",
"p_code":"55",
"code":"62"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Permission Management",
"uri":"en-us_topic_0057845579.html",
"doc_type":"api",
"p_code":"8",
"code":"63"
},
{
"desc":"This API is used to query a role list, including the permissions policies of a role. A role is a set of permissions and represents a group of actions.GET /v3/rolesStatus ",
"product_code":"iam",
"title":"Querying a Role List",
"uri":"en-us_topic_0057845591.html",
"doc_type":"api",
"p_code":"63",
"code":"64"
},
{
"desc":"This API is used to query role details, including the permissions policies of a role. A role is a set of permissions and represents a group of actions.URI formatGET /v3/r",
"product_code":"iam",
"title":"Querying Role Details",
"uri":"en-us_topic_0057845603.html",
"doc_type":"api",
"p_code":"63",
"code":"65"
},
{
"desc":"This API is used to query permission assignment records of a specified account.GET /v3.0/OS-PERMISSION/role-assignmentsStatus code: 200The request is successful.{\n \"ro",
"product_code":"iam",
"title":"Querying Permission Assignment Records",
"uri":"en-us_topic_0000001362626928.html",
"doc_type":"api",
"p_code":"63",
"code":"66"
},
{
"desc":"This API is used to query the user groups to which a specified role has been assigned.URI formatGET /v3/role_assignments{?role.id,user.id,group.id,scope.project.id,scope.",
"product_code":"iam",
"title":"Querying Role Assignments (Discarded)",
"uri":"iam_11_0003.html",
"doc_type":"api",
"p_code":"63",
"code":"67"
},
{
"desc":"This API is used to query the permissions of a user group under a domain. A role is a set of permissions and represents a group of actions.URI formatGET /v3/domains/{doma",
"product_code":"iam",
"title":"Querying Permissions of a User Group Under a Domain",
"uri":"en-us_topic_0057845571.html",
"doc_type":"api",
"p_code":"63",
"code":"68"
},
{
"desc":"This API is used to query the permissions of a specified user group corresponding to a project. A role is a set of permissions and represents a group of actions.URI forma",
"product_code":"iam",
"title":"Querying Permissions of a User Group Corresponding to a Project",
"uri":"en-us_topic_0057845640.html",
"doc_type":"api",
"p_code":"63",
"code":"69"
},
{
"desc":"This API is used to grant permissions to a user group of a domain. A role is a set of permissions and represents a group of actions.URI formatPUT /v3/domains/{domain_id}/",
"product_code":"iam",
"title":"Granting Permissions to a User Group of a Domain",
"uri":"en-us_topic_0057845623.html",
"doc_type":"api",
"p_code":"63",
"code":"70"
},
{
"desc":"This API is used to grant permissions to a user group corresponding to a project. A role is a set of permissions and represents a group of actions.URI formatPUT /v3/proje",
"product_code":"iam",
"title":"Granting Permissions to a User Group Corresponding to a Project",
"uri":"en-us_topic_0057845597.html",
"doc_type":"api",
"p_code":"63",
"code":"71"
},
{
"desc":"This API is used to delete permissions of a user group corresponding to a project. A role is a set of permissions and represents a group of actions.URI formatDELETE /v3/p",
"product_code":"iam",
"title":"Deleting Permissions of a User Group Corresponding to a Project",
"uri":"en-us_topic_0057845572.html",
"doc_type":"api",
"p_code":"63",
"code":"72"
},
{
"desc":"This API is used to delete permissions of a specified user group of a domain. A role is a set of permissions and represents a group of actions.URI formatDELETE /v3/domain",
"product_code":"iam",
"title":"Deleting Permissions of a User Group of a Domain",
"uri":"en-us_topic_0057845560.html",
"doc_type":"api",
"p_code":"63",
"code":"73"
},
{
"desc":"This API is used to query whether a specified user group under a domain has specific permissions. A role is a set of permissions and represents a group of actions.URI for",
"product_code":"iam",
"title":"Querying Whether a User Group Under a Domain Has Specific Permissions",
"uri":"en-us_topic_0057845632.html",
"doc_type":"api",
"p_code":"63",
"code":"74"
},
{
"desc":"This API is used to query whether a user group corresponding to a project has specific permissions. A role is a set of permissions and represents a group of actions.URI f",
"product_code":"iam",
"title":"Querying Whether a User Group Corresponding to a Project Has Specific Permissions",
"uri":"en-us_topic_0057845620.html",
"doc_type":"api",
"p_code":"63",
"code":"75"
},
{
"desc":"This API is used to grant permissions to a user group for all projects.URI formatPUT /v3/OS-INHERIT/domains/{domain_id}/groups/{group_id}/roles/{role_id}/inherited_to_pro",
"product_code":"iam",
"title":"Granting Permissions to a User Group for All Projects",
"uri":"iam_02_0519.html",
"doc_type":"api",
"p_code":"63",
"code":"76"
},
{
"desc":"This API is provided for the administrator to remove the specified permissions of a user group in all projects.DELETE /v3/OS-INHERIT/domains/{domain_id}/groups/{group_id}",
"product_code":"iam",
"title":"Removing Specified Permissions of a User Group in All Projects",
"uri":"iam_10_0013.html",
"doc_type":"api",
"p_code":"63",
"code":"77"
},
{
"desc":"This API is provided for the administrator to check whether a user group has specified permissions for all projects.HEAD /v3/OS-INHERIT/domains/{domain_id}/groups/{group_",
"product_code":"iam",
"title":"Checking Whether a User Group Has Specified Permissions for All Projects",
"uri":"iam_10_0012.html",
"doc_type":"api",
"p_code":"63",
"code":"78"
},
{
"desc":"This API is provided for the administrator to query all permissions that have been assigned to a user group.GET /v3/OS-INHERIT/domains/{domain_id}/groups/{group_id}/roles",
"product_code":"iam",
"title":"Querying All Permissions of a User Group",
"uri":"iam_10_0011.html",
"doc_type":"api",
"p_code":"63",
"code":"79"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Custom Policy Management",
"uri":"iam_02_0010.html",
"doc_type":"api",
"p_code":"8",
"code":"80"
},
{
"desc":"This API is provided for the administrator to list all custom policies.The API can be called using both the global endpoint and region-specific endpoints.GET /v3.0/OS-ROL",
"product_code":"iam",
"title":"Listing Custom Policies",
"uri":"iam_02_0011.html",
"doc_type":"api",
"p_code":"80",
"code":"81"
},
{
"desc":"This API is provided for the administrator to query custom policy details.The API can be called using both the global endpoint and region-specific endpoints.GET /v3.0/OS-",
"product_code":"iam",
"title":"Querying Custom Policy Details",
"uri":"iam_02_0012.html",
"doc_type":"api",
"p_code":"80",
"code":"82"
},
{
"desc":"This API is provided for the administrator to create a custom policy for cloud services.The API can be called using both the global endpoint and region-specific endpoints",
"product_code":"iam",
"title":"Creating a Custom Policy for Cloud Services",
"uri":"iam_02_0013.html",
"doc_type":"api",
"p_code":"80",
"code":"83"
},
{
"desc":"This API is provided for the administrator to create a custom policy.The API can be called using both the global endpoint and region-specific endpoints.POST /v3.0/OS-ROLE",
"product_code":"iam",
"title":"Creating a Custom Policy",
"uri":"iam_11_0016.html",
"doc_type":"api",
"p_code":"80",
"code":"84"
},
{
"desc":"This API is provided for the administrator to modify a custom policy for cloud services.The API can be called using both the global endpoint and region-specific endpoints",
"product_code":"iam",
"title":"Modifying a Custom Policy for Cloud Services",
"uri":"iam_02_0014.html",
"doc_type":"api",
"p_code":"80",
"code":"85"
},
{
"desc":"This API is provided for the administrator to modify a custom policy.The API can be called using both the global endpoint and region-specific endpoints.PATCH /v3.0/OS-ROL",
"product_code":"iam",
"title":"Modifying a Custom Policy",
"uri":"iam_11_0017.html",
"doc_type":"api",
"p_code":"80",
"code":"86"
},
{
"desc":"This API is provided for the administrator to delete a custom policy.The API can be called using both the global endpoint and region-specific endpoints.DELETE /v3.0/OS-RO",
"product_code":"iam",
"title":"Deleting a Custom Policy",
"uri":"iam_02_0015.html",
"doc_type":"api",
"p_code":"80",
"code":"87"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Agency Management",
"uri":"en-us_topic_0079467612.html",
"doc_type":"api",
"p_code":"8",
"code":"88"
},
{
"desc":"This API is used to create an agency.POST /v3.0/OS-AGENCY/agenciesParameters in the request headerParameterMandatoryTypeDescriptionContent-TypeYesStringapplication/json;c",
"product_code":"iam",
"title":"Creating an Agency",
"uri":"en-us_topic_0079467617.html",
"doc_type":"api",
"p_code":"88",
"code":"89"
},
{
"desc":"This API is used to query an agency list based on the specified conditions.URI formatGET /v3.0/OS-AGENCY/agencies{?domain_id,name,trust_domain_id}GET /v3.0/OS-AGENCY/agen",
"product_code":"iam",
"title":"Querying an Agency List Based on the Specified Conditions",
"uri":"en-us_topic_0079467614.html",
"doc_type":"api",
"p_code":"88",
"code":"90"
},
{
"desc":"This API is used to obtain the details of a specified agency.URI formatGET /v3.0/OS-AGENCY/agencies/{agency_id}GET /v3.0/OS-AGENCY/agencies/{agency_id}URI parametersParam",
"product_code":"iam",
"title":"Obtaining Details of a Specified Agency",
"uri":"en-us_topic_0079467615.html",
"doc_type":"api",
"p_code":"88",
"code":"91"
},
{
"desc":"This API is used to modify agency information, including the trust_domain_id, description, and trust_domain_name parameters.URI formatPUT /v3.0/OS-AGENCY/agencies/{agency",
"product_code":"iam",
"title":"Modifying an Agency",
"uri":"en-us_topic_0079467623.html",
"doc_type":"api",
"p_code":"88",
"code":"92"
},
{
"desc":"This API is used to delete an agency.After this operation, the delegated party can no longer access the relevant resources. Exercise caution when performing this operatio",
"product_code":"iam",
"title":"Deleting an Agency",
"uri":"en-us_topic_0079467625.html",
"doc_type":"api",
"p_code":"88",
"code":"93"
},
{
"desc":"This API is used to grant permissions to an agency for a project.URI formatPUT /v3.0/OS-AGENCY/projects/{project_id}/agencies/{agency_id}/roles/{role_id}PUT /v3.0/OS-AGEN",
"product_code":"iam",
"title":"Granting Permissions to an Agency for a Project",
"uri":"en-us_topic_0079467620.html",
"doc_type":"api",
"p_code":"88",
"code":"94"
},
{
"desc":"This API is used to check whether an agency has the specified permissions on a project.URI formatHEAD /v3.0/OS-AGENCY/projects/{project_id}/agencies/{agency_id}/roles/{ro",
"product_code":"iam",
"title":"Checking Whether an Agency Has the Specified Permissions on a Project",
"uri":"en-us_topic_0079578163.html",
"doc_type":"api",
"p_code":"88",
"code":"95"
},
{
"desc":"This API is used to query the list of permissions of an agency on a project.URI formatGET /v3.0/OS-AGENCY/projects/{project_id}/agencies/{agency_id}/rolesGET /v3.0/OS-AGE",
"product_code":"iam",
"title":"Querying the List of Permissions of an Agency on a Project",
"uri":"en-us_topic_0079578164.html",
"doc_type":"api",
"p_code":"88",
"code":"96"
},
{
"desc":"This API is used to delete permissions of an agency on a project.URI formatDELETE /v3.0/OS-AGENCY/projects/{project_id}/agencies/{agency_id}/roles/{role_id}DELETE /v3.0/O",
"product_code":"iam",
"title":"Deleting Permissions of an Agency on a Project",
"uri":"en-us_topic_0079467627.html",
"doc_type":"api",
"p_code":"88",
"code":"97"
},
{
"desc":"This API is used to grant permissions to an agency on a domain.URI formatPUT /v3.0/OS-AGENCY/domains/{domain_id}/agencies/{agency_id}/roles/{role_id}PUT /v3.0/OS-AGENCY/d",
"product_code":"iam",
"title":"Granting Permissions to an Agency on a Domain",
"uri":"en-us_topic_0079467624.html",
"doc_type":"api",
"p_code":"88",
"code":"98"
},
{
"desc":"This API is used to check whether an agency has the specified permissions on a domain.URI formatHEAD /v3.0/OS-AGENCY/domains/{domain_id}/agencies/{agency_id}/roles/{role_",
"product_code":"iam",
"title":"Checking Whether an Agency Has the Specified Permissions on a Domain",
"uri":"en-us_topic_0079578165.html",
"doc_type":"api",
"p_code":"88",
"code":"99"
},
{
"desc":"This API is used to query the list of permissions of an agency on a domain.URI formatGET /v3.0/OS-AGENCY/domains/{domain_id}/agencies/{agency_id}/rolesGET /v3.0/OS-AGENCY",
"product_code":"iam",
"title":"Querying the List of Permissions of an Agency on a Domain",
"uri":"en-us_topic_0079578166.html",
"doc_type":"api",
"p_code":"88",
"code":"100"
},
{
"desc":"This API is used to delete permissions of an agency on a domain.URI formatDELETE /v3.0/OS-AGENCY/domains/{domain_id}/agencies/{agency_id}/roles/{role_id}DELETE /v3.0/OS-A",
"product_code":"iam",
"title":"Deleting Permissions of an Agency on a Domain",
"uri":"en-us_topic_0079467622.html",
"doc_type":"api",
"p_code":"88",
"code":"101"
},
{
"desc":"This API is provided for the administrator to query all permissions that have been assigned to an agency.GET /v3.0/OS-INHERIT/domains/{domain_id}/agencies/{agency_id}/rol",
"product_code":"iam",
"title":"Querying All Permissions of an Agency",
"uri":"iam_02_0040.html",
"doc_type":"api",
"p_code":"88",
"code":"102"
},
{
"desc":"This API is provided for the administrator to grant specified permissions to an agency for all projects.PUT /v3.0/OS-INHERIT/domains/{domain_id}/agencies/{agency_id}/role",
"product_code":"iam",
"title":"Granting Specified Permissions to an Agency for All Projects",
"uri":"iam_02_0041.html",
"doc_type":"api",
"p_code":"88",
"code":"103"
},
{
"desc":"This API is provided for the administrator to check whether an agency has specified permissions.HEAD /v3.0/OS-INHERIT/domains/{domain_id}/agencies/{agency_id}/roles/{role",
"product_code":"iam",
"title":"Checking Whether an Agency Has Specified Permissions",
"uri":"iam_02_0042.html",
"doc_type":"api",
"p_code":"88",
"code":"104"
},
{
"desc":"This API is provided for the administrator to remove the specified permissions of an agency in all projects.DELETE /v3.0/OS-INHERIT/domains/{domain_id}/agencies/{agency_i",
"product_code":"iam",
"title":"Removing Specified Permissions of an Agency in All Projects",
"uri":"iam_02_0043.html",
"doc_type":"api",
"p_code":"88",
"code":"105"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Security Settings",
"uri":"iam_02_0020.html",
"doc_type":"api",
"p_code":"8",
"code":"106"
},
{
"desc":"This API is used to query the operation protection policy.GET /v3.0/OS-SECURITYPOLICY/domains/{domain_id}/protect-policyStatus code: 200The request is successful.Status c",
"product_code":"iam",
"title":"Querying the Operation Protection Policy",
"uri":"iam_02_0022.html",
"doc_type":"api",
"p_code":"106",
"code":"107"
},
{
"desc":"This API is provided for the administrator to modify the operation protection policy.PUT /v3.0/OS-SECURITYPOLICY/domains/{domain_id}/protect-policyStatus code: 200The req",
"product_code":"iam",
"title":"Modifying the Operation Protection Policy",
"uri":"iam_02_0021.html",
"doc_type":"api",
"p_code":"106",
"code":"108"
},
{
"desc":"This API is used to query the password policy.GET /v3.0/OS-SECURITYPOLICY/domains/{domain_id}/password-policyStatus code: 200The request is successful.Status code: 403Acc",
"product_code":"iam",
"title":"Querying the Password Policy",
"uri":"iam_02_0024.html",
"doc_type":"api",
"p_code":"106",
"code":"109"
},
{
"desc":"This API is provided for the administrator to modify the password policy.PUT /v3.0/OS-SECURITYPOLICY/domains/{domain_id}/password-policyStatus code: 200The request is suc",
"product_code":"iam",
"title":"Modifying the Password Policy",
"uri":"iam_02_0023.html",
"doc_type":"api",
"p_code":"106",
"code":"110"
},
{
"desc":"This API is used to query the login authentication policy.GET /v3.0/OS-SECURITYPOLICY/domains/{domain_id}/login-policyStatus code: 200The request is successful.Status cod",
"product_code":"iam",
"title":"Querying the Login Authentication Policy",
"uri":"iam_02_0026.html",
"doc_type":"api",
"p_code":"106",
"code":"111"
},
{
"desc":"This API is provided for the administrator to modify the login authentication policy.PUT /v3.0/OS-SECURITYPOLICY/domains/{domain_id}/login-policyStatus code: 200The reque",
"product_code":"iam",
"title":"Modifying the Login Authentication Policy",
"uri":"iam_02_0025.html",
"doc_type":"api",
"p_code":"106",
"code":"112"
},
{
"desc":"This API is used to query the ACL for console access.GET /v3.0/OS-SECURITYPOLICY/domains/{domain_id}/console-acl-policyStatus code: 200The request is successful.Status co",
"product_code":"iam",
"title":"Querying the ACL for Console Access",
"uri":"iam_02_0028.html",
"doc_type":"api",
"p_code":"106",
"code":"113"
},
{
"desc":"This API is provided for the administrator to modify the ACL for console access.PUT /v3.0/OS-SECURITYPOLICY/domains/{domain_id}/console-acl-policyStatus code: 200The requ",
"product_code":"iam",
"title":"Modifying the ACL for Console Access",
"uri":"iam_02_0027.html",
"doc_type":"api",
"p_code":"106",
"code":"114"
},
{
"desc":"This API is used to query the ACL for API access.GET /v3.0/OS-SECURITYPOLICY/domains/{domain_id}/api-acl-policyStatus code: 200The request is successful.Status code: 403A",
"product_code":"iam",
"title":"Querying the ACL for API Access",
"uri":"iam_02_0030.html",
"doc_type":"api",
"p_code":"106",
"code":"115"
},
{
"desc":"This API is provided for the administrator to modify the ACL for API access.PUT /v3.0/OS-SECURITYPOLICY/domains/{domain_id}/api-acl-policyStatus code: 200The request is s",
"product_code":"iam",
"title":"Modifying the ACL for API Access",
"uri":"iam_02_0029.html",
"doc_type":"api",
"p_code":"106",
"code":"116"
},
{
"desc":"This API is provided for the administrator to query the MFA device information of users.GET /v3.0/OS-MFA/virtual-mfa-devicesStatus code: 200The request is successful.Stat",
"product_code":"iam",
"title":"Querying MFA Device Information of Users",
"uri":"iam_08_0012.html",
"doc_type":"api",
"p_code":"106",
"code":"117"
},
{
"desc":"This API can be used by the administrator to query the MFA device information of a specified user or used by a user to query their MFA device information.GET /v3.0/OS-MFA",
"product_code":"iam",
"title":"Querying the MFA Device Information of a User",
"uri":"iam_08_0013.html",
"doc_type":"api",
"p_code":"106",
"code":"118"
},
{
"desc":"This API is provided for the administrator to query the login protection configurations of users.GET /v3.0/OS-USER/login-protectsStatus code: 200The request is successful",
"product_code":"iam",
"title":"Querying Login Protection Configurations of Users",
"uri":"iam_08_0014.html",
"doc_type":"api",
"p_code":"106",
"code":"119"
},
{
"desc":"This API can be used by the administrator to query the login protection configuration of a specified user or used by a user to query their login protection configuration.",
"product_code":"iam",
"title":"Querying the Login Protection Configuration of a User",
"uri":"iam_08_0016.html",
"doc_type":"api",
"p_code":"106",
"code":"120"
},
{
"desc":"This API is provided for the administrator to modify the login protection configuration of a user.PUT /v3.0/OS-USER/users/{user_id}/login-protectStatus code: 200Status co",
"product_code":"iam",
"title":"Modifying the Login Protection Configuration of a User",
"uri":"iam_08_0021.html",
"doc_type":"api",
"p_code":"106",
"code":"121"
},
{
"desc":"This API is provided for IAM users to bind a virtual MFA device.PUT /v3.0/OS-MFA/mfa-devices/bindNoneNone",
"product_code":"iam",
"title":"Binding a Virtual MFA Device",
"uri":"iam_08_0017.html",
"doc_type":"api",
"p_code":"106",
"code":"122"
},
{
"desc":"This API is used by the administrator to unbind a virtual MFA device from an IAM user, or used by an IAM user to unbind their own virtual MFA device.PUT /v3.0/OS-MFA/mfa-",
"product_code":"iam",
"title":"Unbinding a Virtual MFA Device",
"uri":"iam_08_0018.html",
"doc_type":"api",
"p_code":"106",
"code":"123"
},
{
"desc":"This API is provided for IAM users to create a virtual MFA device.POST /v3.0/OS-MFA/virtual-mfa-devicesStatus code: 201Status code: 201The request is successful.",
"product_code":"iam",
"title":"Creating a Virtual MFA Device",
"uri":"iam_08_0019.html",
"doc_type":"api",
"p_code":"106",
"code":"124"
},
{
"desc":"This API is provided for the administrator to delete their own virtual MFA device.DELETE /v3.0/OS-MFA/virtual-mfa-devicesNoneNone",
"product_code":"iam",
"title":"Deleting a Virtual MFA Device",
"uri":"iam_08_0020.html",
"doc_type":"api",
"p_code":"106",
"code":"125"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Federated Identity Authentication Management",
"uri":"en-us_topic_0057845573.html",
"doc_type":"api",
"p_code":"8",
"code":"126"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Obtaining a Token in Federated Identity Authentication Mode",
"uri":"en-us_topic_0057845646.html",
"doc_type":"api",
"p_code":"126",
"code":"127"
},
{
"desc":"OpenStack and Shibboleth are widely used open-source federated identity authentication solutions. They provide powerful SSO capabilities and connect users to various appl",
"product_code":"iam",
"title":"SP Initiated",
"uri":"iam_02_0001.html",
"doc_type":"api",
"p_code":"127",
"code":"128"
},
{
"desc":"This section uses the Client4ShibbolethIdP script as an example to describe how to obtain a federated authentication token in the IdP-initiated mode. The Client4Shibbolet",
"product_code":"iam",
"title":"IdP Initiated",
"uri":"iam_02_0002.html",
"doc_type":"api",
"p_code":"127",
"code":"129"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Identity Provider",
"uri":"en-us_topic_0057845605.html",
"doc_type":"api",
"p_code":"126",
"code":"130"
},
{
"desc":"This API is used to query the identity provider list.GET /v3/OS-FEDERATION/identity_providersParameters in the request headerParameterMandatoryTypeDescriptionContent-Type",
"product_code":"iam",
"title":"Querying the Identity Provider List",
"uri":"en-us_topic_0057845581.html",
"doc_type":"api",
"p_code":"130",
"code":"131"
},
{
"desc":"This API is used to query the information about an identity provider.URI formatGET /v3/OS-FEDERATION/identity_providers/{id}GET /v3/OS-FEDERATION/identity_providers/{id}U",
"product_code":"iam",
"title":"Querying an Identity Provider",
"uri":"en-us_topic_0057845639.html",
"doc_type":"api",
"p_code":"130",
"code":"132"
},
{
"desc":"This API is provided for the administrator to create an identity provider.URI formatPUT /v3/OS-FEDERATION/identity_providers/{id}PUT /v3/OS-FEDERATION/identity_providers/",
"product_code":"iam",
"title":"Creating an Identity Provider",
"uri":"en-us_topic_0057845606.html",
"doc_type":"api",
"p_code":"130",
"code":"133"
},
{
"desc":"This API is provided for the administrator to create an OpenID Connect identity provider.POST /v3.0/OS-FEDERATION/identity-providers/{idp_id}/openid-connect-configStatus ",
"product_code":"iam",
"title":"Creating an OpenID Connect Identity Provider",
"uri":"iam_13_0207.html",
"doc_type":"api",
"p_code":"130",
"code":"134"
},
{
"desc":"This API is used to update the information about a SAML identity provider.URI formatPATCH /v3/OS-FEDERATION/identity_providers/{id}PATCH /v3/OS-FEDERATION/identity_provid",
"product_code":"iam",
"title":"Updating a SAML Identity Provider",
"uri":"en-us_topic_0057845612.html",
"doc_type":"api",
"p_code":"130",
"code":"135"
},
{
"desc":"This API is provided for the administrator to modify an OpenID Connect identity provider.PUT /v3.0/OS-FEDERATION/identity-providers/{idp_id}/openid-connect-configStatus c",
"product_code":"iam",
"title":"Updating an OpenID Connect Identity Provider",
"uri":"iam_13_0208.html",
"doc_type":"api",
"p_code":"130",
"code":"136"
},
{
"desc":"This API is provided for the administrator to query an OpenID Connect identity provider.GET /v3.0/OS-FEDERATION/identity-providers/{idp_id}/openid-connect-configStatus co",
"product_code":"iam",
"title":"Querying an OpenID Connect Identity Provider",
"uri":"iam_13_0209.html",
"doc_type":"api",
"p_code":"130",
"code":"137"
},
{
"desc":"This API is used to delete a SAML or OpenID Connect identity provider.URI formatDELETE /v3/OS-FEDERATION/identity_providers/{id}DELETE /v3/OS-FEDERATION/identity_provider",
"product_code":"iam",
"title":"Deleting an Identity Provider",
"uri":"en-us_topic_0057845570.html",
"doc_type":"api",
"p_code":"130",
"code":"138"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Mapping",
"uri":"en-us_topic_0057845588.html",
"doc_type":"api",
"p_code":"126",
"code":"139"
},
{
"desc":"This API is used to query the mapping list.GET /v3/OS-FEDERATION/mappingsParameters in the request headerParameterMandatoryTypeDescriptionContent-TypeYesStringFill applic",
"product_code":"iam",
"title":"Querying the Mapping List",
"uri":"en-us_topic_0057845567.html",
"doc_type":"api",
"p_code":"139",
"code":"140"
},
{
"desc":"This API is used to query the information about a mapping.URI formatGET /v3/OS-FEDERATION/mappings/{id}GET /v3/OS-FEDERATION/mappings/{id}URI parametersParameterMandatory",
"product_code":"iam",
"title":"Querying a Mapping",
"uri":"en-us_topic_0057845645.html",
"doc_type":"api",
"p_code":"139",
"code":"141"
},
{
"desc":"This API is used to create a mapping.URI formatPUT /v3/OS-FEDERATION/mappings/{id}PUT /v3/OS-FEDERATION/mappings/{id}URI parametersParameterMandatoryTypeDescriptionidYesS",
"product_code":"iam",
"title":"Creating a Mapping",
"uri":"en-us_topic_0057845590.html",
"doc_type":"api",
"p_code":"139",
"code":"142"
},
{
"desc":"This API is used to update the information about a mapping.URI formatPATCH /v3/OS-FEDERATION/mappings/{id}PATCH /v3/OS-FEDERATION/mappings/{id}URI parametersParameterMand",
"product_code":"iam",
"title":"Updating a Mapping",
"uri":"en-us_topic_0057845568.html",
"doc_type":"api",
"p_code":"139",
"code":"143"
},
{
"desc":"This API is used to delete the information about a mapping.URI formatDELETE /v3/OS-FEDERATION/mappings/{id}DELETE /v3/OS-FEDERATION/mappings/{id}URI parametersParameterMa",
"product_code":"iam",
"title":"Deleting a Mapping",
"uri":"en-us_topic_0057845648.html",
"doc_type":"api",
"p_code":"139",
"code":"144"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Protocol",
"uri":"en-us_topic_0057845619.html",
"doc_type":"api",
"p_code":"126",
"code":"145"
},
{
"desc":"This API is used to query the protocol list.URI formatGET /v3/OS-FEDERATION/identity_providers/{idp_id}/protocolsGET /v3/OS-FEDERATION/identity_providers/{idp_id}/protoco",
"product_code":"iam",
"title":"Querying the Protocol List",
"uri":"en-us_topic_0057845644.html",
"doc_type":"api",
"p_code":"145",
"code":"146"
},
{
"desc":"This API is used to query the information about a protocol.URI formatGET /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}GET /v3/OS-FEDERATION/identi",
"product_code":"iam",
"title":"Querying a Protocol",
"uri":"en-us_topic_0057845616.html",
"doc_type":"api",
"p_code":"145",
"code":"147"
},
{
"desc":"This API is used to register a protocol, that is, associate a rule with an identity provider.URI formatPUT /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protoc",
"product_code":"iam",
"title":"Registering a Protocol",
"uri":"en-us_topic_0057845575.html",
"doc_type":"api",
"p_code":"145",
"code":"148"
},
{
"desc":"This API is used to update the information about a protocol.URI formatPATCH /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}PATCH /v3/OS-FEDERATION/i",
"product_code":"iam",
"title":"Updating a Protocol",
"uri":"en-us_topic_0057845609.html",
"doc_type":"api",
"p_code":"145",
"code":"149"
},
{
"desc":"This API is used to delete the information about a protocol.URI formatDELETE /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}DELETE /v3/OS-FEDERATION",
"product_code":"iam",
"title":"Deleting a Protocol",
"uri":"en-us_topic_0057845559.html",
"doc_type":"api",
"p_code":"145",
"code":"150"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Metadata",
"uri":"en-us_topic_0057845607.html",
"doc_type":"api",
"p_code":"126",
"code":"151"
},
{
"desc":"This API is used to query the content of the metadata file imported by an identity provider to the IAM system.URI formatGET /v3-ext/OS-FEDERATION/identity_providers/{idp_",
"product_code":"iam",
"title":"Querying a Metadata File",
"uri":"en-us_topic_0057845553.html",
"doc_type":"api",
"p_code":"151",
"code":"152"
},
{
"desc":"This API is used to query the metadata file of the keystone.GET /v3-ext/auth/OS-FEDERATION/SSO/metadataParameters in the request headerParameterMandatoryTypeDescriptionun",
"product_code":"iam",
"title":"Querying the Metadata File of Keystone",
"uri":"en-us_topic_0057845577.html",
"doc_type":"api",
"p_code":"151",
"code":"153"
},
{
"desc":"Before using the federated identity authentication function, a metadata file must be imported to the IAM system. This API is used to import a metadata file of a domain.UR",
"product_code":"iam",
"title":"Importing a Metadata File",
"uri":"en-us_topic_0057845615.html",
"doc_type":"api",
"p_code":"151",
"code":"154"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Token",
"uri":"en-us_topic_0057845565.html",
"doc_type":"api",
"p_code":"126",
"code":"155"
},
{
"desc":"This API is used to obtain an unscoped token in SP-initiated federated identity authentication mode.An unscoped token cannot be used for authentication. If a federated us",
"product_code":"iam",
"title":"Obtaining an Unscoped Token (SP Initiated)",
"uri":"en-us_topic_0057845629.html",
"doc_type":"api",
"p_code":"155",
"code":"156"
},
{
"desc":"This API is used to obtain an unscoped token in IdP-initiated federated identity authentication mode.An unscoped token cannot be used for authentication. If a federated u",
"product_code":"iam",
"title":"Obtaining an Unscoped Token (IdP Initiated)",
"uri":"iam_02_0003.html",
"doc_type":"api",
"p_code":"155",
"code":"157"
},
{
"desc":"This API is used to obtain a scoped token through federated identity authentication.POST /v3/auth/tokensStatus code: 201The scoped token is obtained successfully.None",
"product_code":"iam",
"title":"Obtaining a Scoped Token",
"uri":"iam_13_0604.html",
"doc_type":"api",
"p_code":"155",
"code":"158"
},
{
"desc":"This API is used to obtain a federated identity authentication token using an OpenID Connect ID token.POST /v3.0/OS-AUTH/id-token/tokensStatus code: 201Request for obtain",
"product_code":"iam",
"title":"Obtaining a Token with an OpenID Connect ID Token",
"uri":"iam_13_0605.html",
"doc_type":"api",
"p_code":"155",
"code":"159"
},
{
"desc":"This API is used to obtain an unscoped token using an OpenID Connect ID token.POST /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}/authStatus code: ",
"product_code":"iam",
"title":"Obtaining an Unscoped Token with an OpenID Connect ID Token",
"uri":"iam_13_0606.html",
"doc_type":"api",
"p_code":"155",
"code":"160"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Domain",
"uri":"en-us_topic_0057845633.html",
"doc_type":"api",
"p_code":"126",
"code":"161"
},
{
"desc":"This API is used to query the list of domains accessible to federated users.GET /v3/OS-FEDERATION/domainsParameters in the request headerParameterMandatoryTypeDescription",
"product_code":"iam",
"title":"Querying the List of Domains Accessible to Federated Users",
"uri":"en-us_topic_0057845596.html",
"doc_type":"api",
"p_code":"161",
"code":"162"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Project",
"uri":"en-us_topic_0057845643.html",
"doc_type":"api",
"p_code":"126",
"code":"163"
},
{
"desc":"This API is used to query the list of projects accessible to federated users. The project list is used to obtain the scoped token in federated identity authentication mod",
"product_code":"iam",
"title":"Querying the List of Projects Accessible to Federated Users",
"uri":"en-us_topic_0057845595.html",
"doc_type":"api",
"p_code":"163",
"code":"164"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Version Information Management",
"uri":"en-us_topic_0057845631.html",
"doc_type":"api",
"p_code":"8",
"code":"165"
},
{
"desc":"This API is used to obtain the keystone API version information.GET /Example requestResponse parameter descriptionParameterMandatoryTypeDescriptionversionsYesObjectKeysto",
"product_code":"iam",
"title":"Querying Keystone API Version Information",
"uri":"en-us_topic_0057845569.html",
"doc_type":"api",
"p_code":"165",
"code":"166"
},
{
"desc":"This API is used to obtain the information about the keystone API version 3.0.GET /v3Example requestcurl -i -k -X GET https://sample.domain.com/v3Response parameter descr",
"product_code":"iam",
"title":"Querying Information About Keystone API Version 3.0",
"uri":"en-us_topic_0057845613.html",
"doc_type":"api",
"p_code":"165",
"code":"167"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Services and Endpoints",
"uri":"en-us_topic_0057845604.html",
"doc_type":"api",
"p_code":"8",
"code":"168"
},
{
"desc":"This API is used to query the service list.URI formatGET /v3/services{?type}GET /v3/services{?type}URI parametersParameterMandatoryTypeDescriptiontypeNoStringService type",
"product_code":"iam",
"title":"Querying Services",
"uri":"en-us_topic_0057845587.html",
"doc_type":"api",
"p_code":"168",
"code":"169"
},
{
"desc":"This API is used to query service details.URI formatGET /v3/services/{service_id}GET /v3/services/{service_id}URI parametersParameterMandatoryTypeDescriptionservice_idYes",
"product_code":"iam",
"title":"Querying Service Details",
"uri":"en-us_topic_0067148045.html",
"doc_type":"api",
"p_code":"168",
"code":"170"
},
{
"desc":"This API is used to query the list of terminal addresses and provides a service access entry.URI formatGET /v3/endpoints{?interface, service_id}GET /v3/endpoints{?interfa",
"product_code":"iam",
"title":"Querying Endpoints",
"uri":"en-us_topic_0057845562.html",
"doc_type":"api",
"p_code":"168",
"code":"171"
},
{
"desc":"This API is used to query endpoint details.URI formatGET /v3/endpoints/{endpoint_id}GET /v3/endpoints/{endpoint_id}URI parametersParameterMandatoryTypeDescriptionendpoint",
"product_code":"iam",
"title":"Querying Endpoint Details",
"uri":"en-us_topic_0067148046.html",
"doc_type":"api",
"p_code":"168",
"code":"172"
},
{
"desc":"This API is used to query the service catalog corresponding to X-Auth-Token contained in the request.GET /v3/auth/catalogParameters in the request headerParameterMandator",
"product_code":"iam",
"title":"Querying the Service Catalog",
"uri":"iam_02_0004.html",
"doc_type":"api",
"p_code":"168",
"code":"173"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Permissions Policies and Supported Actions",
"uri":"iam_19_0004.html",
"doc_type":"api",
"p_code":"",
"code":"174"
},
{
"desc":"By default, new users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies to these groups. Users inherit permi",
"product_code":"iam",
"title":"Introduction",
"uri":"iam_19_0003.html",
"doc_type":"api",
"p_code":"174",
"code":"175"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Action List",
"uri":"iam_02_0046.html",
"doc_type":"api",
"p_code":"174",
"code":"176"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Appendix",
"uri":"iam_02_0512.html",
"doc_type":"api",
"p_code":"",
"code":"177"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Status Codes",
"uri":"iam_02_0005.html",
"doc_type":"api",
"p_code":"177",
"code":"178"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Error Codes",
"uri":"iam_02_0006.html",
"doc_type":"api",
"p_code":"177",
"code":"179"
},
{
"desc":"Your username, user ID, account name, account ID, project name, and project ID need to be specified in the URI and request body for calling certain APIs. Obtain these par",
"product_code":"iam",
"title":"Obtaining User, Account, User Group, Project, and Agency Information",
"uri":"en-us_topic_0057845624.html",
"doc_type":"api",
"p_code":"177",
"code":"180"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"iam",
"title":"Change History",
"uri":"en-us_topic_0057845564.html",
"doc_type":"api",
"p_code":"",
"code":"181"
}
]
View Git Blame Copy Permalink