1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Identity
  5. getIamWorkRequest
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Identity.getIamWorkRequest

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

This data source provides details about a specific Iam Work Request resource in Oracle Cloud Infrastructure Identity service.

Gets details on a specified IAM work request. For asynchronous operations in Identity and Access Management service, opc-work-request-id header values contains iam work request id that can be provided in this API to track the current status of the operation.

  • If workrequest exists, returns 202 ACCEPTED
  • If workrequest does not exist, returns 404 NOT FOUND

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testIamWorkRequest = oci.Identity.getIamWorkRequest({
    iamWorkRequestId: testIamWorkRequestOciIdentityIamWorkRequest.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_iam_work_request = oci.Identity.get_iam_work_request(iam_work_request_id=test_iam_work_request_oci_identity_iam_work_request["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/identity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := identity.GetIamWorkRequest(ctx, &identity.GetIamWorkRequestArgs{
			IamWorkRequestId: testIamWorkRequestOciIdentityIamWorkRequest.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testIamWorkRequest = Oci.Identity.GetIamWorkRequest.Invoke(new()
    {
        IamWorkRequestId = testIamWorkRequestOciIdentityIamWorkRequest.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Identity.IdentityFunctions;
import com.pulumi.oci.Identity.inputs.GetIamWorkRequestArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testIamWorkRequest = IdentityFunctions.getIamWorkRequest(GetIamWorkRequestArgs.builder()
            .iamWorkRequestId(testIamWorkRequestOciIdentityIamWorkRequest.id())
            .build());

    }
}
Copy
variables:
  testIamWorkRequest:
    fn::invoke:
      function: oci:Identity:getIamWorkRequest
      arguments:
        iamWorkRequestId: ${testIamWorkRequestOciIdentityIamWorkRequest.id}
Copy

Using getIamWorkRequest

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIamWorkRequest(args: GetIamWorkRequestArgs, opts?: InvokeOptions): Promise<GetIamWorkRequestResult>
function getIamWorkRequestOutput(args: GetIamWorkRequestOutputArgs, opts?: InvokeOptions): Output<GetIamWorkRequestResult>
Copy
def get_iam_work_request(iam_work_request_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetIamWorkRequestResult
def get_iam_work_request_output(iam_work_request_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetIamWorkRequestResult]
Copy
func GetIamWorkRequest(ctx *Context, args *GetIamWorkRequestArgs, opts ...InvokeOption) (*GetIamWorkRequestResult, error)
func GetIamWorkRequestOutput(ctx *Context, args *GetIamWorkRequestOutputArgs, opts ...InvokeOption) GetIamWorkRequestResultOutput
Copy

> Note: This function is named GetIamWorkRequest in the Go SDK.

public static class GetIamWorkRequest 
{
    public static Task<GetIamWorkRequestResult> InvokeAsync(GetIamWorkRequestArgs args, InvokeOptions? opts = null)
    public static Output<GetIamWorkRequestResult> Invoke(GetIamWorkRequestInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIamWorkRequestResult> getIamWorkRequest(GetIamWorkRequestArgs args, InvokeOptions options)
public static Output<GetIamWorkRequestResult> getIamWorkRequest(GetIamWorkRequestArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Identity/getIamWorkRequest:getIamWorkRequest
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

IamWorkRequestId This property is required. string
The OCID of the IAM work request.
IamWorkRequestId This property is required. string
The OCID of the IAM work request.
iamWorkRequestId This property is required. String
The OCID of the IAM work request.
iamWorkRequestId This property is required. string
The OCID of the IAM work request.
iam_work_request_id This property is required. str
The OCID of the IAM work request.
iamWorkRequestId This property is required. String
The OCID of the IAM work request.

getIamWorkRequest Result

The following output properties are available:

CompartmentId string
The OCID of the compartment containing this IAM work request.
IamWorkRequestId string
Id string
The provider-assigned unique ID for this managed resource.
OperationType string
The asynchronous operation tracked by this IAM work request.
PercentComplete double
How much progress the operation has made.
Resources List<GetIamWorkRequestResource>
The resources this work request affects.
Status string
Status of the work request
TimeAccepted string
Date and time the work was accepted, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
TimeFinished string
Date and time the work completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
TimeStarted string
Date and time the work started, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
CompartmentId string
The OCID of the compartment containing this IAM work request.
IamWorkRequestId string
Id string
The provider-assigned unique ID for this managed resource.
OperationType string
The asynchronous operation tracked by this IAM work request.
PercentComplete float64
How much progress the operation has made.
Resources []GetIamWorkRequestResource
The resources this work request affects.
Status string
Status of the work request
TimeAccepted string
Date and time the work was accepted, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
TimeFinished string
Date and time the work completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
TimeStarted string
Date and time the work started, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
compartmentId String
The OCID of the compartment containing this IAM work request.
iamWorkRequestId String
id String
The provider-assigned unique ID for this managed resource.
operationType String
The asynchronous operation tracked by this IAM work request.
percentComplete Double
How much progress the operation has made.
resources List<GetIamWorkRequestResource>
The resources this work request affects.
status String
Status of the work request
timeAccepted String
Date and time the work was accepted, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
timeFinished String
Date and time the work completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
timeStarted String
Date and time the work started, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
compartmentId string
The OCID of the compartment containing this IAM work request.
iamWorkRequestId string
id string
The provider-assigned unique ID for this managed resource.
operationType string
The asynchronous operation tracked by this IAM work request.
percentComplete number
How much progress the operation has made.
resources GetIamWorkRequestResource[]
The resources this work request affects.
status string
Status of the work request
timeAccepted string
Date and time the work was accepted, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
timeFinished string
Date and time the work completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
timeStarted string
Date and time the work started, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
compartment_id str
The OCID of the compartment containing this IAM work request.
iam_work_request_id str
id str
The provider-assigned unique ID for this managed resource.
operation_type str
The asynchronous operation tracked by this IAM work request.
percent_complete float
How much progress the operation has made.
resources Sequence[identity.GetIamWorkRequestResource]
The resources this work request affects.
status str
Status of the work request
time_accepted str
Date and time the work was accepted, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
time_finished str
Date and time the work completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
time_started str
Date and time the work started, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
compartmentId String
The OCID of the compartment containing this IAM work request.
iamWorkRequestId String
id String
The provider-assigned unique ID for this managed resource.
operationType String
The asynchronous operation tracked by this IAM work request.
percentComplete Number
How much progress the operation has made.
resources List<Property Map>
The resources this work request affects.
status String
Status of the work request
timeAccepted String
Date and time the work was accepted, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
timeFinished String
Date and time the work completed, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
timeStarted String
Date and time the work started, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Supporting Types

GetIamWorkRequestResource

ActionType This property is required. string
The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.
EntityType This property is required. string
The resource type the work request is affects.
EntityUri This property is required. string
The URI path that the user can do a GET on to access the resource metadata.
Identifier This property is required. string
An OCID of the resource that the work request affects.
ActionType This property is required. string
The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.
EntityType This property is required. string
The resource type the work request is affects.
EntityUri This property is required. string
The URI path that the user can do a GET on to access the resource metadata.
Identifier This property is required. string
An OCID of the resource that the work request affects.
actionType This property is required. String
The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.
entityType This property is required. String
The resource type the work request is affects.
entityUri This property is required. String
The URI path that the user can do a GET on to access the resource metadata.
identifier This property is required. String
An OCID of the resource that the work request affects.
actionType This property is required. string
The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.
entityType This property is required. string
The resource type the work request is affects.
entityUri This property is required. string
The URI path that the user can do a GET on to access the resource metadata.
identifier This property is required. string
An OCID of the resource that the work request affects.
action_type This property is required. str
The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.
entity_type This property is required. str
The resource type the work request is affects.
entity_uri This property is required. str
The URI path that the user can do a GET on to access the resource metadata.
identifier This property is required. str
An OCID of the resource that the work request affects.
actionType This property is required. String
The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.
entityType This property is required. String
The resource type the work request is affects.
entityUri This property is required. String
The URI path that the user can do a GET on to access the resource metadata.
identifier This property is required. String
An OCID of the resource that the work request affects.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi