1. Registry
  2. Packages
  3. Okta Provider
  4. API Docs
  5. Oauth2V1ClientsRoleAppAdmin
Viewing docs for Okta v7.0.0
published on Friday, Sep 11, 2026 by Pulumi
okta logo
Viewing docs for Okta v7.0.0
published on Friday, Sep 11, 2026 by Pulumi

    The Client Role Assignments APIs allow you to assign roles and designate third-party admin status to public client apps.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = new okta.Oauth2V1ClientsRoleAppAdmin("example", {
        clientId: "<client_id>",
        type: "APP_ADMIN",
    });
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.Oauth2V1ClientsRoleAppAdmin("example",
        client_id="<client_id>",
        type="APP_ADMIN")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v7/go/okta"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := okta.NewOauth2V1ClientsRoleAppAdmin(ctx, "example", &okta.Oauth2V1ClientsRoleAppAdminArgs{
    			ClientId: pulumi.String("<client_id>"),
    			Type:     pulumi.String("APP_ADMIN"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Okta.Oauth2V1ClientsRoleAppAdmin("example", new()
        {
            ClientId = "<client_id>",
            Type = "APP_ADMIN",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.Oauth2V1ClientsRoleAppAdmin;
    import com.pulumi.okta.Oauth2V1ClientsRoleAppAdminArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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) {
            var example = new Oauth2V1ClientsRoleAppAdmin("example", Oauth2V1ClientsRoleAppAdminArgs.builder()
                .clientId("<client_id>")
                .type("APP_ADMIN")
                .build());
    
        }
    }
    
    resources:
      example:
        type: okta:Oauth2V1ClientsRoleAppAdmin
        properties:
          clientId: <client_id>
          type: APP_ADMIN
    
    pulumi {
      required_providers {
        okta = {
          source = "pulumi/okta"
        }
      }
    }
    
    resource "okta_oauth2v1clientsroleappadmin" "example" {
      client_id = "<client_id>"
      type      = "APP_ADMIN"
    }
    

    Create Oauth2V1ClientsRoleAppAdmin Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Oauth2V1ClientsRoleAppAdmin(name: string, args: Oauth2V1ClientsRoleAppAdminArgs, opts?: CustomResourceOptions);
    @overload
    def Oauth2V1ClientsRoleAppAdmin(resource_name: str,
                                    args: Oauth2V1ClientsRoleAppAdminArgs,
                                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def Oauth2V1ClientsRoleAppAdmin(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    client_id: Optional[str] = None,
                                    type: Optional[str] = None,
                                    assignment_type: Optional[str] = None,
                                    status: Optional[str] = None)
    func NewOauth2V1ClientsRoleAppAdmin(ctx *Context, name string, args Oauth2V1ClientsRoleAppAdminArgs, opts ...ResourceOption) (*Oauth2V1ClientsRoleAppAdmin, error)
    public Oauth2V1ClientsRoleAppAdmin(string name, Oauth2V1ClientsRoleAppAdminArgs args, CustomResourceOptions? opts = null)
    public Oauth2V1ClientsRoleAppAdmin(String name, Oauth2V1ClientsRoleAppAdminArgs args)
    public Oauth2V1ClientsRoleAppAdmin(String name, Oauth2V1ClientsRoleAppAdminArgs args, CustomResourceOptions options)
    
    type: okta:Oauth2V1ClientsRoleAppAdmin
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "okta_oauth2_v1_clients_role_app_admin" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args Oauth2V1ClientsRoleAppAdminArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args Oauth2V1ClientsRoleAppAdminArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args Oauth2V1ClientsRoleAppAdminArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args Oauth2V1ClientsRoleAppAdminArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args Oauth2V1ClientsRoleAppAdminArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var oauth2V1ClientsRoleAppAdminResource = new Okta.Oauth2V1ClientsRoleAppAdmin("oauth2V1ClientsRoleAppAdminResource", new()
    {
        ClientId = "string",
        Type = "string",
        AssignmentType = "string",
        Status = "string",
    });
    
    example, err := okta.NewOauth2V1ClientsRoleAppAdmin(ctx, "oauth2V1ClientsRoleAppAdminResource", &okta.Oauth2V1ClientsRoleAppAdminArgs{
    	ClientId:       pulumi.String("string"),
    	Type:           pulumi.String("string"),
    	AssignmentType: pulumi.String("string"),
    	Status:         pulumi.String("string"),
    })
    
    resource "okta_oauth2_v1_clients_role_app_admin" "oauth2V1ClientsRoleAppAdminResource" {
      lifecycle {
        create_before_destroy = true
      }
      client_id       = "string"
      type            = "string"
      assignment_type = "string"
      status          = "string"
    }
    
    var oauth2V1ClientsRoleAppAdminResource = new Oauth2V1ClientsRoleAppAdmin("oauth2V1ClientsRoleAppAdminResource", Oauth2V1ClientsRoleAppAdminArgs.builder()
        .clientId("string")
        .type("string")
        .assignmentType("string")
        .status("string")
        .build());
    
    oauth2_v1_clients_role_app_admin_resource = okta.Oauth2V1ClientsRoleAppAdmin("oauth2V1ClientsRoleAppAdminResource",
        client_id="string",
        type="string",
        assignment_type="string",
        status="string")
    
    const oauth2V1ClientsRoleAppAdminResource = new okta.Oauth2V1ClientsRoleAppAdmin("oauth2V1ClientsRoleAppAdminResource", {
        clientId: "string",
        type: "string",
        assignmentType: "string",
        status: "string",
    });
    
    type: okta:Oauth2V1ClientsRoleAppAdmin
    properties:
        assignmentType: string
        clientId: string
        status: string
        type: string
    

    Oauth2V1ClientsRoleAppAdmin Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Oauth2V1ClientsRoleAppAdmin resource accepts the following input properties:

    ClientId string
    clientId of the app
    Type string
    Discriminator field identifying the variant type. Must be set to "APP_ADMIN".
    AssignmentType string
    Role assignment type
    Status string
    Status of the role assignment
    ClientId string
    clientId of the app
    Type string
    Discriminator field identifying the variant type. Must be set to "APP_ADMIN".
    AssignmentType string
    Role assignment type
    Status string
    Status of the role assignment
    client_id string
    clientId of the app
    type string
    Discriminator field identifying the variant type. Must be set to "APP_ADMIN".
    assignment_type string
    Role assignment type
    status string
    Status of the role assignment
    clientId String
    clientId of the app
    type String
    Discriminator field identifying the variant type. Must be set to "APP_ADMIN".
    assignmentType String
    Role assignment type
    status String
    Status of the role assignment
    clientId string
    clientId of the app
    type string
    Discriminator field identifying the variant type. Must be set to "APP_ADMIN".
    assignmentType string
    Role assignment type
    status string
    Status of the role assignment
    client_id str
    clientId of the app
    type str
    Discriminator field identifying the variant type. Must be set to "APP_ADMIN".
    assignment_type str
    Role assignment type
    status str
    Status of the role assignment
    clientId String
    clientId of the app
    type String
    Discriminator field identifying the variant type. Must be set to "APP_ADMIN".
    assignmentType String
    Role assignment type
    status String
    Status of the role assignment

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Oauth2V1ClientsRoleAppAdmin resource produces the following output properties:

    Created string
    Timestamp when the object was created
    Id string
    The provider-assigned unique ID for this managed resource.
    Label string
    Label for the role assignment
    LastUpdated string
    Timestamp when the object was last updated
    Created string
    Timestamp when the object was created
    Id string
    The provider-assigned unique ID for this managed resource.
    Label string
    Label for the role assignment
    LastUpdated string
    Timestamp when the object was last updated
    created string
    Timestamp when the object was created
    id string
    The provider-assigned unique ID for this managed resource.
    label string
    Label for the role assignment
    last_updated string
    Timestamp when the object was last updated
    created String
    Timestamp when the object was created
    id String
    The provider-assigned unique ID for this managed resource.
    label String
    Label for the role assignment
    lastUpdated String
    Timestamp when the object was last updated
    created string
    Timestamp when the object was created
    id string
    The provider-assigned unique ID for this managed resource.
    label string
    Label for the role assignment
    lastUpdated string
    Timestamp when the object was last updated
    created str
    Timestamp when the object was created
    id str
    The provider-assigned unique ID for this managed resource.
    label str
    Label for the role assignment
    last_updated str
    Timestamp when the object was last updated
    created String
    Timestamp when the object was created
    id String
    The provider-assigned unique ID for this managed resource.
    label String
    Label for the role assignment
    lastUpdated String
    Timestamp when the object was last updated

    Look up Existing Oauth2V1ClientsRoleAppAdmin Resource

    Get an existing Oauth2V1ClientsRoleAppAdmin resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: Oauth2V1ClientsRoleAppAdminState, opts?: CustomResourceOptions): Oauth2V1ClientsRoleAppAdmin
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            assignment_type: Optional[str] = None,
            client_id: Optional[str] = None,
            created: Optional[str] = None,
            label: Optional[str] = None,
            last_updated: Optional[str] = None,
            status: Optional[str] = None,
            type: Optional[str] = None) -> Oauth2V1ClientsRoleAppAdmin
    func GetOauth2V1ClientsRoleAppAdmin(ctx *Context, name string, id IDInput, state *Oauth2V1ClientsRoleAppAdminState, opts ...ResourceOption) (*Oauth2V1ClientsRoleAppAdmin, error)
    public static Oauth2V1ClientsRoleAppAdmin Get(string name, Input<string> id, Oauth2V1ClientsRoleAppAdminState? state, CustomResourceOptions? opts = null)
    public static Oauth2V1ClientsRoleAppAdmin get(String name, Output<String> id, Oauth2V1ClientsRoleAppAdminState state, CustomResourceOptions options)
    resources:  _:    type: okta:Oauth2V1ClientsRoleAppAdmin    get:      id: ${id}
    import {
      to = okta_oauth2_v1_clients_role_app_admin.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AssignmentType string
    Role assignment type
    ClientId string
    clientId of the app
    Created string
    Timestamp when the object was created
    Label string
    Label for the role assignment
    LastUpdated string
    Timestamp when the object was last updated
    Status string
    Status of the role assignment
    Type string
    Discriminator field identifying the variant type. Must be set to "APP_ADMIN".
    AssignmentType string
    Role assignment type
    ClientId string
    clientId of the app
    Created string
    Timestamp when the object was created
    Label string
    Label for the role assignment
    LastUpdated string
    Timestamp when the object was last updated
    Status string
    Status of the role assignment
    Type string
    Discriminator field identifying the variant type. Must be set to "APP_ADMIN".
    assignment_type string
    Role assignment type
    client_id string
    clientId of the app
    created string
    Timestamp when the object was created
    label string
    Label for the role assignment
    last_updated string
    Timestamp when the object was last updated
    status string
    Status of the role assignment
    type string
    Discriminator field identifying the variant type. Must be set to "APP_ADMIN".
    assignmentType String
    Role assignment type
    clientId String
    clientId of the app
    created String
    Timestamp when the object was created
    label String
    Label for the role assignment
    lastUpdated String
    Timestamp when the object was last updated
    status String
    Status of the role assignment
    type String
    Discriminator field identifying the variant type. Must be set to "APP_ADMIN".
    assignmentType string
    Role assignment type
    clientId string
    clientId of the app
    created string
    Timestamp when the object was created
    label string
    Label for the role assignment
    lastUpdated string
    Timestamp when the object was last updated
    status string
    Status of the role assignment
    type string
    Discriminator field identifying the variant type. Must be set to "APP_ADMIN".
    assignment_type str
    Role assignment type
    client_id str
    clientId of the app
    created str
    Timestamp when the object was created
    label str
    Label for the role assignment
    last_updated str
    Timestamp when the object was last updated
    status str
    Status of the role assignment
    type str
    Discriminator field identifying the variant type. Must be set to "APP_ADMIN".
    assignmentType String
    Role assignment type
    clientId String
    clientId of the app
    created String
    Timestamp when the object was created
    label String
    Label for the role assignment
    lastUpdated String
    Timestamp when the object was last updated
    status String
    Status of the role assignment
    type String
    Discriminator field identifying the variant type. Must be set to "APP_ADMIN".

    Import

    $ pulumi import okta:index/oauth2V1ClientsRoleAppAdmin:Oauth2V1ClientsRoleAppAdmin example <client_id>/<id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Viewing docs for Okta v7.0.0
    published on Friday, Sep 11, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial