{ "opencollection": "1.0.0", "info": { "name": "Access Management Service Identity API", "version": "20160918" }, "items": [ { "info": { "name": "identity", "type": "folder" }, "items": [ { "info": { "name": "List allowed identity domain license types", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/allowedDomainLicenseTypes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "currentLicenseTypeName", "value": "", "type": "query", "description": "The license type of the identity domain." } ] }, "docs": "(For tenancies that support identity domains) Lists the license types for identity domains supported by Oracle Cloud Infrastructure.\n(License types are also referred to as domain types.)\n\nIf `currentLicenseTypeName` is provided, then the request returns license types that the identity domain with the specified license\ntype name can change to. Otherwise, the request returns all valid license types currently supported.\n" }, { "info": { "name": "GetAuthenticationPolicy", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/authenticationPolicies/:compartmentId", "params": [ { "name": "compartmentId", "value": "", "type": "path", "description": "The OCID of the compartment." } ] }, "docs": "Gets the authentication policy for the given tenancy. You must specify your tenant's OCID as the value for\nthe compartment ID (remember that the tenancy is simply the root compartment).\n" }, { "info": { "name": "UpdateAuthenticationPolicy", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/authenticationPolicies/:compartmentId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "path", "description": "The OCID of the compartment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates authentication policy for the specified tenancy.\n" }, { "info": { "name": "ListAvailabilityDomains", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/availabilityDomains/", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" } ] }, "docs": "Lists the availability domains in your tenancy. Specify the OCID of either the tenancy or another\nof your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five).\nNote that the order of the results returned can change if availability domains are added or removed; therefore, do not\ncreate a dependency on the list order.\n" }, { "info": { "name": "ListCompartments", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/compartments/", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `ANY` and `ACCESSIBLE`. Default is `ANY`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). For the compartments on which the user indirectly has\nINSPECT permissions, a restricted set of fields is returned.\n\nWhen set to `ANY` permissions are not checked.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Default is false. Can only be set to true when performing\nListCompartments on the tenancy (root compartment).\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the the setting of `accessLevel`.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to only return resources that match the given name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Lists the compartments in a specified compartment. The members of the list\nreturned depends on the values set for several parameters.\n\nWith the exception of the tenancy (root compartment), the ListCompartments operation\nreturns only the first-level child compartments in the parent compartment specified in\n`compartmentId`. The list does not include any subcompartments of the child\ncompartments (grandchildren).\n\nThe parameter `accessLevel` specifies whether to return only those compartments for wh" }, { "info": { "name": "CreateCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/compartments/", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new compartment in the specified compartment.\n\nSpecify the parent compartment's OCID as the compartment ID in the request object. Remember that the tenancy\nis simply the root compartment. For information about OCIDs, see\n[Resource Identifiers](/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the compartment, which must be unique across all compartments in\nyour tenancy. You can use this name or the OCID when writing policies that apply\nto the compartment. " }, { "info": { "name": "ListBulkActionResourceTypes", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/compartments/bulkActionResourceTypes", "params": [ { "name": "bulkActionType", "value": "", "type": "query", "description": "The type of bulk action.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" } ] }, "docs": "Lists the resource-types supported by compartment bulk actions. Use this API to help you provide the correct\nresource-type information to the [BulkDeleteResources](#/en/identity/20160918/Compartment/BulkDeleteResources/)\nand [BulkMoveResources](#/en/identity/20160918/Compartment/BulkMoveResources/) operations. The returned list of\nresource-types provides the appropriate resource-type names to use with the bulk action operations along with\nthe type of identifying information you'll need to provid" }, { "info": { "name": "GetCompartment", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/compartments/:compartmentId", "params": [ { "name": "compartmentId", "value": "", "type": "path", "description": "The OCID of the compartment." } ] }, "docs": "Gets the specified compartment's information.\n\nThis operation does not return a list of all the resources inside the compartment. There is no single\nAPI operation that does that. Compartments can contain multiple types of resources (instances, block\nstorage volumes, etc.). To find out what's in a compartment, you must call the \"List\" operation for\neach resource type and specify the compartment's OCID as a query parameter in the request. For example,\ncall the [ListInstances](#/en/iaas/20160918/In" }, { "info": { "name": "UpdateCompartment", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/compartments/:compartmentId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "path", "description": "The OCID of the compartment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified compartment's description or name. You can't update the root compartment." }, { "info": { "name": "DeleteCompartment", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/compartments/:compartmentId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "path", "description": "The OCID of the compartment." } ] }, "docs": "Deletes the specified compartment. The compartment must be empty.\n" }, { "info": { "name": "Bulk delete resources in the compartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/compartments/:compartmentId/actions/bulkDeleteResources", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "path", "description": "The OCID of the compartment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes multiple resources in the compartment. All resources must be in the same compartment. You must have the appropriate\npermissions to delete the resources in the request. This API can only be invoked from the tenancy's\n[home region](/Content/Identity/regions/managingregions.htm#Home). This operation creates a\n[WorkRequest](#/en/workrequests/20160918/WorkRequest/). Use the [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest)\nAPI to monitor the status of the bulk action.\n" }, { "info": { "name": "Move multiple resources at once to a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/compartments/:compartmentId/actions/bulkMoveResources", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "path", "description": "The OCID of the compartment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves multiple resources from one compartment to another. All resources must be in the same compartment.\nThis API can only be invoked from the tenancy's [home region](/Content/Identity/regions/managingregions.htm#Home).\nTo move resources, you must have the appropriate permissions to move the resource in both the source and target\ncompartments. This operation creates a [WorkRequest](#/en/workrequests/20160918/WorkRequest/).\nUse the [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRe" }, { "info": { "name": "Moves a compartment tree to a different parent compartment. When provided,\nIf-Match is checked against ETag values of the resource.\n", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/compartments/:compartmentId/actions/moveCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "path", "description": "The OCID of the compartment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move the compartment to a different parent compartment in the same tenancy. When you move a\ncompartment, all its contents (subcompartments and resources) are moved with it. Note that\nthe `CompartmentId` that you specify in the path is the compartment that you want to move.\n\n**IMPORTANT**: After you move a compartment to a new parent compartment, the access policies of\nthe new parent take effect and the policies of the previous parent no longer apply. Ensure that you\nare aware of the implications" }, { "info": { "name": "RecoverCompartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/compartments/:compartmentId/actions/recoverCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "path", "description": "The OCID of the compartment." } ] }, "docs": "Recover the compartment from DELETED state to ACTIVE state.\n" }, { "info": { "name": "ListDomains", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/domains/", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "The mutable display name of the identity domain." }, { "name": "url", "value": "", "type": "query", "description": "The region-agnostic identity domain URL." }, { "name": "homeRegionUrl", "value": "", "type": "query", "description": "The region-specific identity domain URL." }, { "name": "type", "value": "", "type": "query", "description": "The identity domain type." }, { "name": "licenseType", "value": "", "type": "query", "description": "The license type of the identity domain." }, { "name": "isHiddenOnLogin", "value": "", "type": "query", "description": "Indicates whether or not the identity domain is visible at the sign-in screen." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to only return resources that match the given name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "(For tenancies that support identity domains) Lists all identity domains within a tenancy.\n" }, { "info": { "name": "CreateDomain", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/domains/", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "(For tenancies that support identity domains) Creates a new identity domain in the tenancy with the identity domain home in `homeRegion`.\nAfter you send your request, the temporary `lifecycleState` of this identity domain is set to CREATING and `lifecycleDetails` to UPDATING.\nWhen creation of the identity domain completes, this identity domain's `lifecycleState` is set to ACTIVE and `lifecycleDetails` to null.\n\nTo track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/" }, { "info": { "name": "GetDomain", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/domains/:domainId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "domainId", "value": "", "type": "path", "description": "The OCID of the identity domain." } ] }, "docs": "(For tenancies that support identity domains) Gets the specified identity domain's information.\n" }, { "info": { "name": "UpdateDomain", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/domains/:domainId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "domainId", "value": "", "type": "path", "description": "The OCID of the identity domain." } ], "body": { "type": "json", "data": "{}" } }, "docs": "(For tenancies that support identity domains) Updates identity domain information and the associated Identity Cloud Service (IDCS) stripe.\n\nTo track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves\nthe operation's status.\n" }, { "info": { "name": "DeleteDomain", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/domains/:domainId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "domainId", "value": "", "type": "path", "description": "The OCID of the identity domain." } ] }, "docs": "(For tenancies that support identity domains) Deletes an identity domain. The identity domain must have no active apps present in\nthe underlying IDCS stripe. You must also deactivate the identity domain, rendering the `lifecycleState` of the identity domain INACTIVE.\nFurthermore, as the authenticated user performing the operation, you cannot be a member of the identity domain you are deleting.\nLastly, you cannot delete the default identity domain. A tenancy must always have at least the default " }, { "info": { "name": "Activate a deactivated domain", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/domains/:domainId/actions/activate", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "domainId", "value": "", "type": "path", "description": "The OCID of the identity domain." } ] }, "docs": "(For tenancies that support identity domains) Activates a deactivated identity domain. You can only activate identity domains that your user account is not a part of.\n\nAfter you send the request, the `lifecycleDetails` of the identity domain is set to ACTIVATING. When the operation completes, the\n`lifecycleDetails` is set to null and the `lifecycleState` of the identity domain is set to ACTIVE.\n\nTo track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequests" }, { "info": { "name": "Change domain compartment", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/domains/:domainId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "domainId", "value": "", "type": "path", "description": "The OCID of the identity domain." } ], "body": { "type": "json", "data": "{}" } }, "docs": "(For tenancies that support identity domains) Moves the identity domain to a different compartment in the tenancy.\n\nTo track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves\nthe operation's status.\n" }, { "info": { "name": "Change the license type of an identity domain", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/domains/:domainId/actions/changeLicenseType", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "domainId", "value": "", "type": "path", "description": "The OCID of the identity domain." } ], "body": { "type": "json", "data": "{}" } }, "docs": "(For tenancies that support identity domains) Changes the license type of the given identity domain. The identity domain's\n`lifecycleState` must be set to ACTIVE and the requested `licenseType` must be allowed. To retrieve the allowed `licenseType` for\nthe identity domain, use [ListAllowedDomainLicenseTypes](#/en/identity/20160918/Domain/ListAllowedDomainLicenseTypes).\n\nAfter you send your request, the `lifecycleDetails` of this identity domain is set to UPDATING. When the update of the identity" }, { "info": { "name": "Deactivate an active identity domain.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/domains/:domainId/actions/deactivate", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "domainId", "value": "", "type": "path", "description": "The OCID of the identity domain." }, { "name": "isForceDeactivate", "value": "", "type": "query", "description": "Indicates whether domain can be forcefully deactivated even when there are Active Apps present" } ] }, "docs": "(For tenancies that support identity domains) Deactivates the specified identity domain. Identity domains must be in an ACTIVE\n`lifecycleState` and have no active apps present in the domain or underlying Identity Cloud Service stripe. You cannot deactivate\nthe default identity domain.\n\nAfter you send your request, the `lifecycleDetails` of this identity domain is set to DEACTIVATING. When the operation completes,\nthen the `lifecycleDetails` is set to null and the `lifecycleState` is set to INACT" }, { "info": { "name": "Replicate identity domain to a new region", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/domains/:domainId/actions/enableReplicationToRegion", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "domainId", "value": "", "type": "path", "description": "The OCID of the identity domain." } ], "body": { "type": "json", "data": "{}" } }, "docs": "(For tenancies that support identity domains) Replicates the identity domain to a new region (provided that the region is the\ntenancy home region or other region that the tenancy subscribes to). You can only replicate identity domains that are in an ACTIVE\n`lifecycleState` and not currently updating or already replicating. You also can only trigger the replication of secondary identity domains.\nThe default identity domain is automatically replicated to all regions that the tenancy subscribes to." }, { "info": { "name": "ListDynamicGroups", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/dynamicGroups/", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to only return resources that match the given name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Lists the dynamic groups in your tenancy. You must specify your tenancy's OCID as the value for\nthe compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five).\n" }, { "info": { "name": "CreateDynamicGroup", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/dynamicGroups/", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new dynamic group in your tenancy.\n\nYou must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy\nis simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies)\nreside within the tenancy itself, unlike cloud resources such as compute instances, which typically\nreside within compartments inside the tenancy. For information about OCIDs, see\n[Resource Identifiers](/Content/General/Concepts/identifie" }, { "info": { "name": "GetDynamicGroup", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/dynamicGroups/:dynamicGroupId", "params": [ { "name": "dynamicGroupId", "value": "", "type": "path", "description": "The OCID of the dynamic group." } ] }, "docs": "Gets the specified dynamic group's information.\n" }, { "info": { "name": "UpdateDynamicGroup", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/dynamicGroups/:dynamicGroupId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "dynamicGroupId", "value": "", "type": "path", "description": "The OCID of the dynamic group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified dynamic group." }, { "info": { "name": "DeleteDynamicGroup", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/dynamicGroups/:dynamicGroupId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "dynamicGroupId", "value": "", "type": "path", "description": "The OCID of the dynamic group." } ] }, "docs": "Deletes the specified dynamic group.\n" }, { "info": { "name": "ListFaultDomains", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/faultDomains/", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availabilityDomain.\n" } ] }, "docs": "Lists the Fault Domains in your tenancy. Specify the OCID of either the tenancy or another\nof your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five).\n" }, { "info": { "name": "ListGroups", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/groups/", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to only return resources that match the given name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Lists the groups in your tenancy. You must specify your tenancy's OCID as the value for\nthe compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five).\n" }, { "info": { "name": "CreateGroup", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/groups/", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new group in your tenancy.\n\nYou must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy\nis simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies)\nreside within the tenancy itself, unlike cloud resources such as compute instances, which typically\nreside within compartments inside the tenancy. For information about OCIDs, see\n[Resource Identifiers](/Content/General/Concepts/identifiers.htm)." }, { "info": { "name": "GetGroup", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/groups/:groupId", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The OCID of the group." } ] }, "docs": "Gets the specified group's information.\n\nThis operation does not return a list of all the users in the group. To do that, use\n[ListUserGroupMemberships](#/en/identity/20160918/UserGroupMembership/ListUserGroupMemberships) and\nprovide the group's OCID as a query parameter in the request.\n" }, { "info": { "name": "UpdateGroup", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/groups/:groupId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The OCID of the group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified group." }, { "info": { "name": "DeleteGroup", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/groups/:groupId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The OCID of the group." } ] }, "docs": "Deletes the specified group. The group must be empty.\n" }, { "info": { "name": "List IAM work requests", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/iamWorkRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "resourceIdentifier", "value": "", "type": "query", "description": "The identifier of the resource the work request affects." } ] }, "docs": "Lists the IAM work requests in compartment. The workRequestID is returned in the opc-work-request-id header for any asynchronous operation in the Identity and Access Management service.\n" }, { "info": { "name": "Gets IAM work request", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/iamWorkRequests/:iamWorkRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "iamWorkRequestId", "value": "", "type": "path", "description": "The OCID of the IAM work request." } ] }, "docs": "Gets the details of a specified IAM work request. The workRequestID is returned in the opc-work-request-id header for any asynchronous operation in the Identity and Access Management service.\n" }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/iamWorkRequests/:iamWorkRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "iamWorkRequestId", "value": "", "type": "path", "description": "The OCID of the IAM work request." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n" } ] }, "docs": "Gets error details for a specified IAM work request. The workRequestID is returned in the opc-work-request-id header for any asynchronous operation in the Identity and Access Management service.\n" }, { "info": { "name": "List IAM workrequest logs", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/iamWorkRequests/:iamWorkRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "iamWorkRequestId", "value": "", "type": "path", "description": "The OCID of the IAM work request." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n" } ] }, "docs": "Gets logs for a specified IAM work request. The workRequestID is returned in the opc-work-request-id header for any asynchronous operation in the Identity and Access Management service.\n" }, { "info": { "name": "GetIdcsDomainServiceStatus", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/idcsDomainServiceStatus", "headers": [ { "name": "opc-request-id", "value": "" } ] }, "docs": "Internal API to get the IDCS domain service status, value being true specifies secondary domain can be created in\nregion being build , value being false signifies otherwise\n" }, { "info": { "name": "ListIdentityProviders", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/identityProviders/", "params": [ { "name": "protocol", "value": "", "type": "query", "description": "The protocol used for federation." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to only return resources that match the given name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).\n\nLists all the identity providers in your tenancy. You must specify the identity provider type (e.g., `SAML2` for\nidentity providers using the SAML2.0 protocol). You must specify your tenancy's OCID as the value for the\ncompartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisi" }, { "info": { "name": "CreateIdentityProvider", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/identityProviders/", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).\n\nCreates a new identity provider in your tenancy. For more information, see\n[Identity Providers and Federation](/Content/Identity/Concepts/federation.htm).\n\nYou must specify your tenancy's OCID as the compartment ID in the request object.\nRemember that the tenancy is simply the root compartment. For information about\nOCIDs, see [Resource Identifiers](/Content/General/Concep" }, { "info": { "name": "GetIdentityProvider", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/identityProviders/:identityProviderId", "params": [ { "name": "identityProviderId", "value": "", "type": "path", "description": "The OCID of the identity provider." } ] }, "docs": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).\n\nGets the specified identity provider's information.\n" }, { "info": { "name": "UpdateIdentityProvider", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/identityProviders/:identityProviderId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "identityProviderId", "value": "", "type": "path", "description": "The OCID of the identity provider." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).\n\nUpdates the specified identity provider.\n" }, { "info": { "name": "DeleteIdentityProvider", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/identityProviders/:identityProviderId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "identityProviderId", "value": "", "type": "path", "description": "The OCID of the identity provider." } ] }, "docs": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).\n\nDeletes the specified identity provider. The identity provider must not have\nany group mappings (see [IdpGroupMapping](#/en/identity/20160918/IdpGroupMapping/)).\n" }, { "info": { "name": "ResetIdpScimClient", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/identityProviders/:identityProviderId/actions/resetScimClient/", "params": [ { "name": "identityProviderId", "value": "", "type": "path", "description": "The OCID of the identity provider." } ] }, "docs": "Resets the OAuth2 client credentials for the SCIM client associated with this identity provider.\n" }, { "info": { "name": "ListIdpGroupMappings", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/identityProviders/:identityProviderId/groupMappings/", "params": [ { "name": "identityProviderId", "value": "", "type": "path", "description": "The OCID of the identity provider." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" } ] }, "docs": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).\n\nLists the group mappings for the specified identity provider.\n" }, { "info": { "name": "CreateIdpGroupMapping", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/identityProviders/:identityProviderId/groupMappings/", "headers": [ { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "identityProviderId", "value": "", "type": "path", "description": "The OCID of the identity provider." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).\n\nCreates a single mapping between an IdP group and an IAM Service\n[group](#/en/identity/20160918/Group/).\n" }, { "info": { "name": "GetIdpGroupMapping", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/identityProviders/:identityProviderId/groupMappings/:mappingId", "params": [ { "name": "identityProviderId", "value": "", "type": "path", "description": "The OCID of the identity provider." }, { "name": "mappingId", "value": "", "type": "path", "description": "The OCID of the group mapping." } ] }, "docs": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).\n\nGets the specified group mapping.\n" }, { "info": { "name": "UpdateIdpGroupMapping", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/identityProviders/:identityProviderId/groupMappings/:mappingId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "identityProviderId", "value": "", "type": "path", "description": "The OCID of the identity provider." }, { "name": "mappingId", "value": "", "type": "path", "description": "The OCID of the group mapping." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).\n\nUpdates the specified group mapping.\n" }, { "info": { "name": "DeleteIdpGroupMapping", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/identityProviders/:identityProviderId/groupMappings/:mappingId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "identityProviderId", "value": "", "type": "path", "description": "The OCID of the identity provider." }, { "name": "mappingId", "value": "", "type": "path", "description": "The OCID of the group mapping." } ] }, "docs": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).\n\nDeletes the specified group mapping.\n" }, { "info": { "name": "Gets the identity provider groups.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/identityProviders/:identityProviderId/groups/", "params": [ { "name": "identityProviderId", "value": "", "type": "path", "description": "The OCID of the identity provider." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to only return resources that match the given name exactly.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).\n\nLists the identity provider groups.\n" }, { "info": { "name": "ListNetworkSources", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/networkSources", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to only return resources that match the given name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Lists the network sources in your tenancy. You must specify your tenancy's OCID as the value for\nthe compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five).\n" }, { "info": { "name": "CreateNetworkSource", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/networkSources", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new network source in your tenancy.\n\nYou must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy\nis simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies)\nreside within the tenancy itself, unlike cloud resources such as compute instances, which typically\nreside within compartments inside the tenancy. For information about OCIDs, see\n[Resource Identifiers](/Content/General/Concepts/identifi" }, { "info": { "name": "GetNetworkSource", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/networkSources/:networkSourceId", "params": [ { "name": "networkSourceId", "value": "", "type": "path", "description": "The OCID of the network source." } ] }, "docs": "Gets the specified network source's information.\n" }, { "info": { "name": "UpdateNetworkSource", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/networkSources/:networkSourceId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "networkSourceId", "value": "", "type": "path", "description": "The OCID of the network source." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified network source.\n" }, { "info": { "name": "DeleteNetworkSource", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/networkSources/:networkSourceId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "networkSourceId", "value": "", "type": "path", "description": "The OCID of the network source." } ] }, "docs": "Deletes the specified network source.\n" }, { "info": { "name": "ListPolicies", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/policies/", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to only return resources that match the given name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Lists the policies in the specified compartment (either the tenancy or another of your compartments).\nSee [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five).\n\nTo determine which policies apply to a particular group or compartment, you must view the individual\nstatements inside all your policies. There isn't a way to automatically obtain that information via the API.\n" }, { "info": { "name": "CreatePolicy", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/policies/", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new policy in the specified compartment (either the tenancy or another of your compartments).\nIf you're new to policies, see [Get Started with Policies](/Content/Identity/policiesgs/get-started-with-policies.htm).\n\nYou must specify a *name* for the policy, which must be unique across all policies in your tenancy\nand cannot be changed.\n\nYou must also specify a *description* for the policy (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime " }, { "info": { "name": "GetPolicy", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/policies/:policyId", "params": [ { "name": "policyId", "value": "", "type": "path", "description": "The OCID of the policy." } ] }, "docs": "Gets the specified policy's information." }, { "info": { "name": "UpdatePolicy", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/policies/:policyId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "policyId", "value": "", "type": "path", "description": "The OCID of the policy." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified policy. You can update the description or the policy statements themselves.\n\nPolicy changes take effect typically within 10 seconds.\n" }, { "info": { "name": "DeletePolicy", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/policies/:policyId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "policyId", "value": "", "type": "path", "description": "The OCID of the policy." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the specified policy. The deletion takes effect typically within 10 seconds." }, { "info": { "name": "Add a resource lock to a policy", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/policies/:policyId/actions/addLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "policyId", "value": "", "type": "path", "description": "The OCID of the policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a resource lock to a tag namespace.\n" }, { "info": { "name": "Remove a resource lock to a policy", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/policies/:policyId/actions/removeLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "policyId", "value": "", "type": "path", "description": "The OCID of the policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a resource lock to a policy\n" }, { "info": { "name": "ListRegions", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/regions" }, "docs": "Lists all the regions offered by Oracle Cloud Infrastructure." }, { "info": { "name": "ListTagDefaults", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/tagDefaults", "params": [ { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "id", "value": "", "type": "query", "description": "A filter to only return resources that match the specified OCID exactly.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "tagDefinitionId", "value": "", "type": "query", "description": "The OCID of the tag definition.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Lists the tag defaults for tag definitions in the specified compartment.\n" }, { "info": { "name": "CreateTagDefault", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/tagDefaults", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new tag default in the specified compartment for the specified tag definition.\n\nIf you specify that a value is required, a value is set during resource creation (either by\nthe user creating the resource or another tag defualt). If no value is set, resource creation\nis blocked.\n\n* If the `isRequired` flag is set to \"true\", the value is set during resource creation.\n* If the `isRequired` flag is set to \"false\", the value you enter is set during resource creation.\n" }, { "info": { "name": "AssembleEffectiveTagSet", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/tagDefaults/actions/assembleEffectiveTagSet", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Assembles tag defaults in the specified compartment and any parent compartments to determine\nthe tags to apply. Tag defaults from parent compartments do not override tag defaults\nreferencing the same tag in a compartment lower down the hierarchy. This set of tag defaults\nincludes all tag defaults from the current compartment back to the root compartment.\n" }, { "info": { "name": "GetTagDefault", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/tagDefaults/:tagDefaultId", "params": [ { "name": "tagDefaultId", "value": "", "type": "path", "description": "The OCID of the tag default." } ] }, "docs": "Retrieves the specified tag default.\n" }, { "info": { "name": "UpdateTagDefault", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/tagDefaults/:tagDefaultId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tagDefaultId", "value": "", "type": "path", "description": "The OCID of the tag default." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified tag default. If you specify that a value is required, a value is set\nduring resource creation (either by the user creating the resource or another tag defualt).\nIf no value is set, resource creation is blocked.\n\n* If the `isRequired` flag is set to \"true\", the value is set during resource creation.\n* If the `isRequired` flag is set to \"false\", the value you enter is set during resource creation.\n" }, { "info": { "name": "DeleteTagDefault", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/tagDefaults/:tagDefaultId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "tagDefaultId", "value": "", "type": "path", "description": "The OCID of the tag default." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the the specified tag default.\n" }, { "info": { "name": "Add a resource lock to a tag default", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/tagDefaults/:tagDefaultId/actions/addLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "tagDefaultId", "value": "", "type": "path", "description": "The OCID of the tag default." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a resource lock to a tag default.\n" }, { "info": { "name": "Remove a resource lock from a tag default", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/tagDefaults/:tagDefaultId/actions/removeLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "tagDefaultId", "value": "", "type": "path", "description": "The OCID of the tag default." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a resource lock from a tag default.\n" }, { "info": { "name": "ListTagNamespaces", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/tagNamespaces", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "includeSubcompartments", "value": "", "type": "query", "description": "An optional boolean parameter indicating whether to retrieve all tag namespaces in subcompartments. If this\nparameter is not specified, only the tag namespaces defined in the specified compartment are retrieved.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Lists the tag namespaces in the specified compartment.\n" }, { "info": { "name": "CreateTagNamespace", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/tagNamespaces", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new tag namespace in the specified compartment.\n\nYou must specify the compartment ID in the request object (remember that the tenancy is simply the root\ncompartment).\n\nYou must also specify a *name* for the namespace, which must be unique across all namespaces in your tenancy\nand cannot be changed. The name can contain any ASCII character except the space (_) or period (.).\nNames are case insensitive. That means, for example, \"myNamespace\" and \"mynamespace\" are not allowed\nin the same " }, { "info": { "name": "ListCostTrackingTags", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/tagNamespaces/actions/listCostTrackingTags", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" } ] }, "docs": "Lists all the tags enabled for cost-tracking in the specified tenancy. For information about\ncost-tracking tags, see [Using Cost-tracking Tags](/Content/Tagging/Tasks/usingcosttrackingtags.htm).\n" }, { "info": { "name": "GetTagNamespace", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/tagNamespaces/:tagNamespaceId", "params": [ { "name": "tagNamespaceId", "value": "", "type": "path", "description": "The OCID of the tag namespace.\n" } ] }, "docs": "Gets the specified tag namespace's information.\n" }, { "info": { "name": "UpdateTagNamespace", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/tagNamespaces/:tagNamespaceId", "params": [ { "name": "tagNamespaceId", "value": "", "type": "path", "description": "The OCID of the tag namespace.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the the specified tag namespace. You can't update the namespace name.\n\nUpdating `isRetired` to 'true' retires the namespace and all the tag definitions in the namespace. Reactivating a\nnamespace (changing `isRetired` from 'true' to 'false') does not reactivate tag definitions.\nTo reactivate the tag definitions, you must reactivate each one individually *after* you reactivate the namespace,\nusing [UpdateTag](#/en/identity/20160918/Tag/UpdateTag). For more information about retiring tag na" }, { "info": { "name": "DeleteTagNamespace", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/tagNamespaces/:tagNamespaceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tagNamespaceId", "value": "", "type": "path", "description": "The OCID of the tag namespace.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the specified tag namespace. Only an empty tag namespace can be deleted with this operation. To use this operation\nto delete a tag namespace that contains tag definitions, first delete all of its tag definitions.\n\nUse [CascadeDeleteTagNamespace](#/en/identity/20160918/TagNamespace/CascadeDeleteTagNamespace) to delete a tag namespace along with all of\nthe tag definitions contained within that namespace.\n\nUse [DeleteTag](#/en/identity/latest/Tag/DeleteTag) to delete a tag definition.\n" }, { "info": { "name": "Add a resource lock to a tag namespace", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/tagNamespaces/:tagNamespaceId/actions/addLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "tagNamespaceId", "value": "", "type": "path", "description": "The OCID of the tag namespace.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a resource lock to a tag namespace.\n" }, { "info": { "name": "Delete tag namespace that contains tags", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/tagNamespaces/:tagNamespaceId/actions/cascadeDelete", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "tagNamespaceId", "value": "", "type": "path", "description": "The OCID of the tag namespace.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the specified tag namespace. This operation triggers a process that removes all of the tags\ndefined in the specified tag namespace from all resources in your tenancy and then deletes the tag namespace.\n\nAfter you start the delete operation:\n\n * New tag key definitions cannot be created under the namespace.\n * The state of the tag namespace changes to DELETING.\n * Tag removal from the resources begins.\n\nThis process can take up to 48 hours depending on the number of tag definitions in " }, { "info": { "name": "changes compartment of a tag namespace.", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/tagNamespaces/:tagNamespaceId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "tagNamespaceId", "value": "", "type": "path", "description": "The OCID of the tag namespace.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified tag namespace to the specified compartment within the same tenancy.\n\nTo move the tag namespace, you must have the manage tag-namespaces permission on both compartments.\nFor more information about IAM policies, see [Details for IAM](/Content/Identity/policyreference/iampolicyreference.htm).\n\nMoving a tag namespace moves all the tag key definitions contained in the tag namespace.\n" }, { "info": { "name": "Remove a resource lock from a tag namespace", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/tagNamespaces/:tagNamespaceId/actions/removeLock", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "tagNamespaceId", "value": "", "type": "path", "description": "The OCID of the tag namespace.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a resource lock from a tag namespace.\n" }, { "info": { "name": "ListTags", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/tagNamespaces/:tagNamespaceId/tags", "params": [ { "name": "tagNamespaceId", "value": "", "type": "path", "description": "The OCID of the tag namespace.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Lists the tag definitions in the specified tag namespace.\n" }, { "info": { "name": "CreateTag", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/tagNamespaces/:tagNamespaceId/tags", "headers": [ { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "tagNamespaceId", "value": "", "type": "path", "description": "The OCID of the tag namespace.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new tag in the specified tag namespace.\n\nThe tag requires either the OCID or the name of the tag namespace that will contain this\ntag definition.\n\nYou must specify a *name* for the tag, which must be unique across all tags in the tag namespace\nand cannot be changed. The name can contain any ASCII character except the space (_) or period (.) characters.\nNames are case insensitive. That means, for example, \"myTag\" and \"mytag\" are not allowed in the same namespace.\nIf you specify a name t" }, { "info": { "name": "GetTag", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/tagNamespaces/:tagNamespaceId/tags/:tagName", "params": [ { "name": "tagNamespaceId", "value": "", "type": "path", "description": "The OCID of the tag namespace.\n" }, { "name": "tagName", "value": "", "type": "path", "description": "The name of the tag.\n" } ] }, "docs": "Gets the specified tag's information." }, { "info": { "name": "UpdateTag", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/tagNamespaces/:tagNamespaceId/tags/:tagName", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "tagNamespaceId", "value": "", "type": "path", "description": "The OCID of the tag namespace.\n" }, { "name": "tagName", "value": "", "type": "path", "description": "The name of the tag.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified tag definition.\n\nSetting `validator` determines the value type. Tags can use either a static value or a\nlist of possible values. Static values are entered by a user applying the tag to a resource.\nLists are created by you and the user must apply a value from the list. On update, any values\nin a list that were previously set do not change, but new values must pass validation. Values\nalready applied to a resource do not change.\n\nYou cannot remove list values that appear in a " }, { "info": { "name": "DeleteTag", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/tagNamespaces/:tagNamespaceId/tags/:tagName", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "tagNamespaceId", "value": "", "type": "path", "description": "The OCID of the tag namespace.\n" }, { "name": "tagName", "value": "", "type": "path", "description": "The name of the tag.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the specified tag definition. This operation triggers a process that removes the\ntag from all resources in your tenancy.\n\nThese things happen immediately:\n * If the tag was a cost-tracking tag, it no longer counts against your 10 cost-tracking\n tags limit, whether you first disabled it or not.\n * If the tag was used with dynamic groups, none of the rules that contain the tag will\n be evaluated against the tag.\n\nWhen you start the delete operation, the state of the tag changes to DELE" }, { "info": { "name": "ListTaggingWorkRequests", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/taggingWorkRequests/", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "resourceIdentifier", "value": "", "type": "query", "description": "The identifier of the resource the work request affects." } ] }, "docs": "Lists the tagging work requests in compartment.\n" }, { "info": { "name": "GetTaggingWorkRequest", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/taggingWorkRequests/:workRequestId", "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." } ] }, "docs": "Gets details on a specified work request. The workRequestID is returned in the opc-work-request-id header\nfor any asynchronous operation in tagging service.\n" }, { "info": { "name": "ListTaggingWorkRequestErrors", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/taggingWorkRequests/:workRequestId/errors", "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" } ] }, "docs": "Gets the errors for a work request.\n" }, { "info": { "name": "ListTaggingWorkRequestLogs", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/taggingWorkRequests/:workRequestId/logs", "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" } ] }, "docs": "Gets the logs for a work request.\n" }, { "info": { "name": "Delete multiple tag key definitions at the same time", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/tags/actions/bulkDelete", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes the specified tag key definitions. This operation triggers a process that removes the\ntags from all resources in your tenancy. The tag key definitions must be within the same tag namespace.\n\nThe following actions happen immediately:\n\n * If the tag is a cost-tracking tag, the tag no longer counts against your\n 10 cost-tracking tags limit, even if you do not disable the tag before running this operation.\n * If the tag is used with dynamic groups, the rules that contain the tag are no lo" }, { "info": { "name": "Edit multiple tag key definitions on resources", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/tags/actions/bulkEdit", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edits the specified list of tag key definitions for the selected resources.\nThis operation triggers a process that edits the tags on all selected resources. The possible actions are:\n\n * Add a defined tag when the tag does not already exist on the resource.\n * Update the value for a defined tag when the tag is present on the resource.\n * Add a defined tag when it does not already exist on the resource or update the value for a defined tag when the tag is present on the resource.\n * Remove a " }, { "info": { "name": "Create or update tag namespace and their tag definitions if a given tag namespace is a standard tag namespace.\nIf the tag namespace already exists, any missing tag definitions will be added. For existing enum tags, any new enum values will be added.\nDeleting tagging entities nor removing enum values are not supported.\n", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/tags/actions/importStandardTags", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "OCI will release Tag Namespaces that our customers can import.\nThese Tag Namespaces will provide Tags for our customers and Partners to provide consistency and enable data reporting.\n" }, { "info": { "name": "ListBulkEditTagsResourceTypes", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/tags/bulkEditResourceTypes", "params": [ { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" } ] }, "docs": "Lists the resource types that support bulk tag editing.\n" }, { "info": { "name": "ListStandardTagNamespaceTemplates", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/tags/standardTagNamespaceTemplates", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" } ] }, "docs": "Lists available standard tag namespaces that users can create.\n" }, { "info": { "name": "GetStandardTagTemplate", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/tags/standardTagNamespaceTemplates/:standardTagNamespaceName", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "standardTagNamespaceName", "value": "", "type": "path", "description": "The name of the standard tag namespace tempate that is requested\n" } ] }, "docs": "Retrieve the standard tag namespace template given the standard tag namespace name.\n" }, { "info": { "name": "GetTenancy", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/tenancies/:tenancyId", "params": [ { "name": "tenancyId", "value": "", "type": "path", "description": "The OCID of the tenancy." } ] }, "docs": "Get the specified tenancy's information." }, { "info": { "name": "ListRegionSubscriptions", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/tenancies/:tenancyId/regionSubscriptions", "params": [ { "name": "tenancyId", "value": "", "type": "path", "description": "The OCID of the tenancy." } ] }, "docs": "Lists the region subscriptions for the specified tenancy." }, { "info": { "name": "CreateRegionSubscription", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/tenancies/:tenancyId/regionSubscriptions", "headers": [ { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "tenancyId", "value": "", "type": "path", "description": "The OCID of the tenancy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a subscription to a region for a tenancy.\n" }, { "info": { "name": "ListUserGroupMemberships", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/userGroupMemberships/", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "userId", "value": "", "type": "query", "description": "The OCID of the user." }, { "name": "groupId", "value": "", "type": "query", "description": "The OCID of the group." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" } ] }, "docs": "Lists the `UserGroupMembership` objects in your tenancy. You must specify your tenancy's OCID\nas the value for the compartment ID\n(see [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five)).\nYou must also then filter the list in one of these ways:\n\n- You can limit the results to just the memberships for a given user by specifying a `userId`.\n- Similarly, you can limit the results to just the memberships for a given group by specifying a `groupId`.\n- You " }, { "info": { "name": "AddUserToGroup", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/userGroupMemberships/", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified user to the specified group and returns a `UserGroupMembership` object with its own OCID.\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n" }, { "info": { "name": "GetUserGroupMembership", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/userGroupMemberships/:userGroupMembershipId", "params": [ { "name": "userGroupMembershipId", "value": "", "type": "path", "description": "The OCID of the userGroupMembership." } ] }, "docs": "Gets the specified UserGroupMembership's information." }, { "info": { "name": "RemoveUserFromGroup", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/userGroupMemberships/:userGroupMembershipId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "userGroupMembershipId", "value": "", "type": "path", "description": "The OCID of the userGroupMembership." } ] }, "docs": "Removes a user from a group by deleting the corresponding `UserGroupMembership`." }, { "info": { "name": "ListUsers", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/users/", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "identityProviderId", "value": "", "type": "query", "description": "The id of the identity provider.\n" }, { "name": "externalIdentifier", "value": "", "type": "query", "description": "The id of a user in the identity provider.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to only return resources that match the given name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Lists the users in your tenancy. You must specify your tenancy's OCID as the value for the\ncompartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five).\n" }, { "info": { "name": "CreateUser", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/users/", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new user in your tenancy. For conceptual information about users, your tenancy, and other\nIAM Service components, see [Overview of IAM](/Content/Identity/getstarted/identity-domains.htm).\n\nYou must specify your tenancy's OCID as the compartment ID in the request object (remember that the\ntenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and\nsome policies) reside within the tenancy itself, unlike cloud resources such as compute instances,\nw" }, { "info": { "name": "GetUser", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/users/:userId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ] }, "docs": "Gets the specified user's information." }, { "info": { "name": "UpdateUser", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/users/:userId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the description of the specified user." }, { "info": { "name": "DeleteUser", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/users/:userId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ] }, "docs": "Deletes the specified user. The user must not be in any groups." }, { "info": { "name": "ListApiKeys", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/users/:userId/apiKeys/", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ] }, "docs": "Lists the API signing keys for the specified user. A user can have a maximum of three keys.\n\nEvery user has permission to use this API call for *their own user ID*. An administrator in your\norganization does not need to write a policy to give users this ability.\n" }, { "info": { "name": "UploadApiKey", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/users/:userId/apiKeys/", "headers": [ { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Uploads an API signing key for the specified user.\n\nEvery user has permission to use this operation to upload a key for *their own user ID*. An\nadministrator in your organization does not need to write a policy to give users this ability.\nTo compare, administrators who have permission to the tenancy can use this operation to upload a\nkey for any user, including themselves.\n\n**Important:** Even though you have permission to upload an API key, you might not yet\nhave permission to do much else. If " }, { "info": { "name": "DeleteApiKey", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/users/:userId/apiKeys/:fingerprint", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "fingerprint", "value": "", "type": "path", "description": "The key's fingerprint." } ] }, "docs": "Deletes the specified API signing key for the specified user.\n\nEvery user has permission to use this operation to delete a key for *their own user ID*. An\nadministrator in your organization does not need to write a policy to give users this ability.\nTo compare, administrators who have permission to the tenancy can use this operation to delete\na key for any user, including themselves.\n" }, { "info": { "name": "ListAuthTokens", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/users/:userId/authTokens/", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ] }, "docs": "Lists the auth tokens for the specified user. The returned object contains the token's OCID, but not\nthe token itself. The actual token is returned only upon creation.\n" }, { "info": { "name": "CreateAuthToken", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/users/:userId/authTokens/", "headers": [ { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new auth token for the specified user. For information about what auth tokens are for, see\n[Managing User Credentials](/Content/Identity/access/managing-user-credentials.htm).\n\nYou must specify a *description* for the auth token (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with\n[UpdateAuthToken](#/en/identity/20160918/AuthToken/UpdateAuthToken).\n\nEvery user has permission to create an auth token for *their own user ID*. An administr" }, { "info": { "name": "UpdateAuthToken", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/users/:userId/authTokens/:authTokenId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "authTokenId", "value": "", "type": "path", "description": "The OCID of the auth token." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified auth token's description.\n" }, { "info": { "name": "DeleteAuthToken", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/users/:userId/authTokens/:authTokenId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "authTokenId", "value": "", "type": "path", "description": "The OCID of the auth token." } ] }, "docs": "Deletes the specified auth token for the specified user.\n" }, { "info": { "name": "UpdateUserCapabilities", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/users/:userId/capabilities/", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the capabilities of the specified user.\n" }, { "info": { "name": "ListCustomerSecretKeys", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/users/:userId/customerSecretKeys/", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ] }, "docs": "Lists the secret keys for the specified user. The returned object contains the secret key's OCID, but not\nthe secret key itself. The actual secret key is returned only upon creation.\n" }, { "info": { "name": "CreateCustomerSecretKey", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/users/:userId/customerSecretKeys/", "headers": [ { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new secret key for the specified user. Secret keys are used for authentication with the Object Storage Service's Amazon S3\ncompatible API. The secret key consists of an Access Key/Secret Key pair. For information, see\n[Managing User Credentials](/Content/Identity/access/managing-user-credentials.htm).\n\nYou must specify a *description* for the secret key (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with\n[UpdateCustomerSecretKey](#/en" }, { "info": { "name": "UpdateCustomerSecretKey", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/users/:userId/customerSecretKeys/:customerSecretKeyId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "customerSecretKeyId", "value": "", "type": "path", "description": "The access token of the secret key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified secret key's description.\n" }, { "info": { "name": "DeleteCustomerSecretKey", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/users/:userId/customerSecretKeys/:customerSecretKeyId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "customerSecretKeyId", "value": "", "type": "path", "description": "The access token of the secret key." } ] }, "docs": "Deletes the specified secret key for the specified user.\n" }, { "info": { "name": "ListDbCredentials", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/users/:userId/dbCredentials/", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to only return resources that match the given name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Lists the DB credentials for the specified user. The returned object contains the credential's OCID\n" }, { "info": { "name": "CreateDbCredential", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/users/:userId/dbCredentials/", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new DB credential for the specified user.\n" }, { "info": { "name": "DeleteDbCredential", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/users/:userId/dbCredentials/:dbCredentialId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "dbCredentialId", "value": "", "type": "path", "description": "The OCID of the DB credential." } ] }, "docs": "Deletes the specified DB credential for the specified user.\n" }, { "info": { "name": "ListMfaTotpDevices", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/users/:userId/mfaTotpDevices", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists the MFA TOTP devices for the specified user. The returned object contains the device's OCID, but not\nthe seed. The seed is returned only upon creation or when the IAM service regenerates the MFA seed for the device.\n" }, { "info": { "name": "CreateMfaTotpDevice", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/users/:userId/mfaTotpDevices", "headers": [ { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ] }, "docs": "Creates a new MFA TOTP device for the user. A user can have one MFA TOTP device.\n" }, { "info": { "name": "GetMfaTotpDevice", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/users/:userId/mfaTotpDevices/:mfaTotpDeviceId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "mfaTotpDeviceId", "value": "", "type": "path", "description": "The OCID of the MFA TOTP device." } ] }, "docs": "Get the specified MFA TOTP device for the specified user.\n" }, { "info": { "name": "DeleteMfaTotpDevice", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/users/:userId/mfaTotpDevices/:mfaTotpDeviceId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "mfaTotpDeviceId", "value": "", "type": "path", "description": "The OCID of the MFA TOTP device." } ] }, "docs": "Deletes the specified MFA TOTP device for the specified user.\n" }, { "info": { "name": "ActivateMfaTotpDevice", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/users/:userId/mfaTotpDevices/:mfaTotpDeviceId/actions/activate", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "mfaTotpDeviceId", "value": "", "type": "path", "description": "The OCID of the MFA TOTP device." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Activates the specified MFA TOTP device for the user. Activation requires manual interaction with the Console.\n" }, { "info": { "name": "GenerateTotpSeed", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/users/:userId/mfaTotpDevices/:mfaTotpDeviceId/actions/generateSeed", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "mfaTotpDeviceId", "value": "", "type": "path", "description": "The OCID of the MFA TOTP device." } ] }, "docs": "Generate seed for the MFA TOTP device.\n" }, { "info": { "name": "List of Oauth tokens for the user", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/users/:userId/oauth2ClientCredentials", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "List of Oauth tokens for the user\n" }, { "info": { "name": "Creates Oauth token for the user", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/users/:userId/oauth2ClientCredentials", "headers": [ { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates Oauth token for the user\n" }, { "info": { "name": "Updates Oauth token for the user", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/users/:userId/oauth2ClientCredentials/:oauth2ClientCredentialId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "oauth2ClientCredentialId", "value": "", "type": "path", "description": "The ID of the Oauth credential." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates Oauth token for the user\n" }, { "info": { "name": "Delete Oauth token for the user", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/users/:userId/oauth2ClientCredentials/:oauth2ClientCredentialId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "oauth2ClientCredentialId", "value": "", "type": "path", "description": "The ID of the Oauth credential." } ] }, "docs": "Delete Oauth token for the user\n" }, { "info": { "name": "ListSmtpCredentials", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/users/:userId/smtpCredentials/", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ] }, "docs": "Lists the SMTP credentials for the specified user. The returned object contains the credential's OCID,\nthe SMTP user name but not the SMTP password. The SMTP password is returned only upon creation.\n" }, { "info": { "name": "CreateSmtpCredential", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/users/:userId/smtpCredentials/", "headers": [ { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new SMTP credential for the specified user. An SMTP credential has an SMTP user name and an SMTP password.\nYou must specify a *description* for the SMTP credential (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with\n[UpdateSmtpCredential](#/en/identity/20160918/SmtpCredentialSummary/UpdateSmtpCredential).\n" }, { "info": { "name": "UpdateSmtpCredential", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/users/:userId/smtpCredentials/:smtpCredentialId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "smtpCredentialId", "value": "", "type": "path", "description": "The OCID of the SMTP credential." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified SMTP credential's description.\n" }, { "info": { "name": "DeleteSmtpCredential", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/users/:userId/smtpCredentials/:smtpCredentialId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "smtpCredentialId", "value": "", "type": "path", "description": "The OCID of the SMTP credential." } ] }, "docs": "Deletes the specified SMTP credential for the specified user.\n" }, { "info": { "name": "UpdateUserState", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/users/:userId/state/", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the state of the specified user.\n" }, { "info": { "name": "ListSwiftPasswords", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/users/:userId/swiftPasswords/", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ] }, "docs": "**Deprecated. Use [ListAuthTokens](#/en/identity/20160918/AuthToken/ListAuthTokens) instead.**\n\nLists the Swift passwords for the specified user. The returned object contains the password's OCID, but not\nthe password itself. The actual password is returned only upon creation.\n" }, { "info": { "name": "CreateSwiftPassword", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/users/:userId/swiftPasswords/", "headers": [ { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecated. Use [CreateAuthToken](#/en/identity/20160918/AuthToken/CreateAuthToken) instead.**\n\nCreates a new Swift password for the specified user. For information about what Swift passwords are for, see\n[Managing User Credentials](/Content/Identity/Tasks/managingcredentials.htm).\n\nYou must specify a *description* for the Swift password (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with\n[UpdateSwiftPassword](#/en/identity/20160918/SwiftPass" }, { "info": { "name": "UpdateSwiftPassword", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:9000/20160918/users/:userId/swiftPasswords/:swiftPasswordId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "swiftPasswordId", "value": "", "type": "path", "description": "The OCID of the Swift password." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecated. Use [UpdateAuthToken](#/en/identity/20160918/AuthToken/UpdateAuthToken) instead.**\n\nUpdates the specified Swift password's description.\n" }, { "info": { "name": "DeleteSwiftPassword", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:9000/20160918/users/:userId/swiftPasswords/:swiftPasswordId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." }, { "name": "swiftPasswordId", "value": "", "type": "path", "description": "The OCID of the Swift password." } ] }, "docs": "**Deprecated. Use [DeleteAuthToken](#/en/identity/20160918/AuthToken/DeleteAuthToken) instead.**\n\nDeletes the specified Swift password for the specified user.\n" }, { "info": { "name": "GetUserUIPasswordInformation", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/users/:userId/uiPassword", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ] }, "docs": "Gets the specified user's console password information. The returned object contains the user's OCID,\nbut not the password itself. The actual password is returned only when created or reset.\n" }, { "info": { "name": "CreateOrResetUIPassword", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:9000/20160918/users/:userId/uiPassword", "headers": [ { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The OCID of the user." } ] }, "docs": "Creates a new Console one-time password for the specified user. For more information about user\ncredentials, see [User Credentials](/Content/Identity/usercred/usercredentials.htm).\n\nUse this operation after creating a new user, or if a user forgets their password. The new one-time\npassword is returned to you in the response, and you must securely deliver it to the user. They'll\nbe prompted to change this password the next time they sign in to the Console. If they don't change\nit within 7 days, t" }, { "info": { "name": "ListWorkRequests", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/workRequests/", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment (remember that the tenancy is simply the root compartment).\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "resourceIdentifier", "value": "", "type": "query", "description": "The identifier of the resource the work request affects." } ] }, "docs": "Lists the work requests in compartment.\n" }, { "info": { "name": "GetWorkRequest", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:9000/20160918/workRequests/:workRequestId", "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." } ] }, "docs": "Gets details on a specified work request. The workRequestID is returned in the opc-work-request-id header\nfor any asynchronous operation in the compartment service.\n" } ] } ], "bundled": true }