1. Packages
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. OidcApp
Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community
Schema (JSON)
akeyless-community/terraform-provider-akeyless

akeyless.OidcApp

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community
Schema (JSON)
akeyless-community/terraform-provider-akeyless

    OIDC App resource

    Create OidcApp Resource

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

    Constructor syntax

    new OidcApp(name: string, args: OidcAppArgs, opts?: CustomResourceOptions);
    @overload
def OidcApp(resource_name: str,
            args: OidcAppArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def OidcApp(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            permission_assignment: Optional[str] = None,
            name: Optional[str] = None,
            delete_protection: Optional[str] = None,
            description: Optional[str] = None,
            item_custom_fields: Optional[Mapping[str, str]] = None,
            key: Optional[str] = None,
            accessibility: Optional[str] = None,
            oidc_app_id: Optional[str] = None,
            audience: Optional[str] = None,
            public: Optional[bool] = None,
            redirect_uris: Optional[Sequence[str]] = None,
            scopes: Optional[Sequence[str]] = None,
            tags: Optional[Sequence[str]] = None)
    func NewOidcApp(ctx *Context, name string, args OidcAppArgs, opts ...ResourceOption) (*OidcApp, error)
    public OidcApp(string name, OidcAppArgs args, CustomResourceOptions? opts = null)
    public OidcApp(String name, OidcAppArgs args)
public OidcApp(String name, OidcAppArgs args, CustomResourceOptions options)

    type: akeyless:OidcApp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OidcAppArgs
    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 OidcAppArgs
    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 OidcAppArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OidcAppArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OidcAppArgs
    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 oidcAppResource = new Akeyless.OidcApp("oidcAppResource", new()
{
    PermissionAssignment = "string",
    Name = "string",
    DeleteProtection = "string",
    Description = "string",
    ItemCustomFields = 
    {
        { "string", "string" },
    },
    Key = "string",
    Accessibility = "string",
    OidcAppId = "string",
    Audience = "string",
    Public = false,
    RedirectUris = new[]
    {
        "string",
    },
    Scopes = new[]
    {
        "string",
    },
    Tags = new[]
    {
        "string",
    },
});

    example, err := akeyless.NewOidcApp(ctx, "oidcAppResource", &akeyless.OidcAppArgs{
	PermissionAssignment: pulumi.String("string"),
	Name:                 pulumi.String("string"),
	DeleteProtection:     pulumi.String("string"),
	Description:          pulumi.String("string"),
	ItemCustomFields: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Key:           pulumi.String("string"),
	Accessibility: pulumi.String("string"),
	OidcAppId:     pulumi.String("string"),
	Audience:      pulumi.String("string"),
	Public:        pulumi.Bool(false),
	RedirectUris: pulumi.StringArray{
		pulumi.String("string"),
	},
	Scopes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var oidcAppResource = new OidcApp("oidcAppResource", OidcAppArgs.builder()
    .permissionAssignment("string")
    .name("string")
    .deleteProtection("string")
    .description("string")
    .itemCustomFields(Map.of("string", "string"))
    .key("string")
    .accessibility("string")
    .oidcAppId("string")
    .audience("string")
    .public_(false)
    .redirectUris("string")
    .scopes("string")
    .tags("string")
    .build());

    oidc_app_resource = akeyless.OidcApp("oidcAppResource",
    permission_assignment="string",
    name="string",
    delete_protection="string",
    description="string",
    item_custom_fields={
        "string": "string",
    },
    key="string",
    accessibility="string",
    oidc_app_id="string",
    audience="string",
    public=False,
    redirect_uris=["string"],
    scopes=["string"],
    tags=["string"])

    const oidcAppResource = new akeyless.OidcApp("oidcAppResource", {
    permissionAssignment: "string",
    name: "string",
    deleteProtection: "string",
    description: "string",
    itemCustomFields: {
        string: "string",
    },
    key: "string",
    accessibility: "string",
    oidcAppId: "string",
    audience: "string",
    "public": false,
    redirectUris: ["string"],
    scopes: ["string"],
    tags: ["string"],
});

    type: akeyless:OidcApp
properties:
    accessibility: string
    audience: string
    deleteProtection: string
    description: string
    itemCustomFields:
        string: string
    key: string
    name: string
    oidcAppId: string
    permissionAssignment: string
    public: false
    redirectUris:
        - string
    scopes:
        - string
    tags:
        - string

    OidcApp 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 OidcApp resource accepts the following input properties:

    PermissionAssignment string
    A json array string defining the access permission assignment for this OIDC app. Supports two formats: 1) Auth method: [{"assignmenttype":"AUTHMETHOD","accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}] 2) Group: [{"assignmenttype":"GROUP","groupid":"grp-xyz789"}]
    Accessibility string
    For personal password manager
    Audience string
    A comma separated list of allowed audiences
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    ItemCustomFields Dictionary<string, string>
    Additional custom fields to associate with the item
    Key string
    The name of a key that used to encrypt the OIDC application (if empty, the account default protectionKey key will be used)
    Name string
    OIDC App name
    OidcAppId string
    The ID of this resource.
    Public bool
    Set to true if the app is public (cannot keep secrets)
    RedirectUris List<string>
    A comma separated list of allowed redirect uris
    Scopes List<string>
    A comma separated list of allowed scopes
    Tags List<string>
    Add tags attached to this object
    PermissionAssignment string
    A json array string defining the access permission assignment for this OIDC app. Supports two formats: 1) Auth method: [{"assignmenttype":"AUTHMETHOD","accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}] 2) Group: [{"assignmenttype":"GROUP","groupid":"grp-xyz789"}]
    Accessibility string
    For personal password manager
    Audience string
    A comma separated list of allowed audiences
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    ItemCustomFields map[string]string
    Additional custom fields to associate with the item
    Key string
    The name of a key that used to encrypt the OIDC application (if empty, the account default protectionKey key will be used)
    Name string
    OIDC App name
    OidcAppId string
    The ID of this resource.
    Public bool
    Set to true if the app is public (cannot keep secrets)
    RedirectUris []string
    A comma separated list of allowed redirect uris
    Scopes []string
    A comma separated list of allowed scopes
    Tags []string
    Add tags attached to this object
    permissionAssignment String
    A json array string defining the access permission assignment for this OIDC app. Supports two formats: 1) Auth method: [{"assignmenttype":"AUTHMETHOD","accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}] 2) Group: [{"assignmenttype":"GROUP","groupid":"grp-xyz789"}]
    accessibility String
    For personal password manager
    audience String
    A comma separated list of allowed audiences
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    itemCustomFields Map<String,String>
    Additional custom fields to associate with the item
    key String
    The name of a key that used to encrypt the OIDC application (if empty, the account default protectionKey key will be used)
    name String
    OIDC App name
    oidcAppId String
    The ID of this resource.
    public_ Boolean
    Set to true if the app is public (cannot keep secrets)
    redirectUris List<String>
    A comma separated list of allowed redirect uris
    scopes List<String>
    A comma separated list of allowed scopes
    tags List<String>
    Add tags attached to this object
    permissionAssignment string
    A json array string defining the access permission assignment for this OIDC app. Supports two formats: 1) Auth method: [{"assignmenttype":"AUTHMETHOD","accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}] 2) Group: [{"assignmenttype":"GROUP","groupid":"grp-xyz789"}]
    accessibility string
    For personal password manager
    audience string
    A comma separated list of allowed audiences
    deleteProtection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    itemCustomFields {[key: string]: string}
    Additional custom fields to associate with the item
    key string
    The name of a key that used to encrypt the OIDC application (if empty, the account default protectionKey key will be used)
    name string
    OIDC App name
    oidcAppId string
    The ID of this resource.
    public boolean
    Set to true if the app is public (cannot keep secrets)
    redirectUris string[]
    A comma separated list of allowed redirect uris
    scopes string[]
    A comma separated list of allowed scopes
    tags string[]
    Add tags attached to this object
    permission_assignment str
    A json array string defining the access permission assignment for this OIDC app. Supports two formats: 1) Auth method: [{"assignmenttype":"AUTHMETHOD","accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}] 2) Group: [{"assignmenttype":"GROUP","groupid":"grp-xyz789"}]
    accessibility str
    For personal password manager
    audience str
    A comma separated list of allowed audiences
    delete_protection str
    Protection from accidental deletion of this object [true/false]
    description str
    Description of the object
    item_custom_fields Mapping[str, str]
    Additional custom fields to associate with the item
    key str
    The name of a key that used to encrypt the OIDC application (if empty, the account default protectionKey key will be used)
    name str
    OIDC App name
    oidc_app_id str
    The ID of this resource.
    public bool
    Set to true if the app is public (cannot keep secrets)
    redirect_uris Sequence[str]
    A comma separated list of allowed redirect uris
    scopes Sequence[str]
    A comma separated list of allowed scopes
    tags Sequence[str]
    Add tags attached to this object
    permissionAssignment String
    A json array string defining the access permission assignment for this OIDC app. Supports two formats: 1) Auth method: [{"assignmenttype":"AUTHMETHOD","accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}] 2) Group: [{"assignmenttype":"GROUP","groupid":"grp-xyz789"}]
    accessibility String
    For personal password manager
    audience String
    A comma separated list of allowed audiences
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    itemCustomFields Map<String>
    Additional custom fields to associate with the item
    key String
    The name of a key that used to encrypt the OIDC application (if empty, the account default protectionKey key will be used)
    name String
    OIDC App name
    oidcAppId String
    The ID of this resource.
    public Boolean
    Set to true if the app is public (cannot keep secrets)
    redirectUris List<String>
    A comma separated list of allowed redirect uris
    scopes List<String>
    A comma separated list of allowed scopes
    tags List<String>
    Add tags attached to this object

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing OidcApp Resource

    Get an existing OidcApp 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?: OidcAppState, opts?: CustomResourceOptions): OidcApp
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accessibility: Optional[str] = None,
        audience: Optional[str] = None,
        delete_protection: Optional[str] = None,
        description: Optional[str] = None,
        item_custom_fields: Optional[Mapping[str, str]] = None,
        key: Optional[str] = None,
        name: Optional[str] = None,
        oidc_app_id: Optional[str] = None,
        permission_assignment: Optional[str] = None,
        public: Optional[bool] = None,
        redirect_uris: Optional[Sequence[str]] = None,
        scopes: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[str]] = None) -> OidcApp
    func GetOidcApp(ctx *Context, name string, id IDInput, state *OidcAppState, opts ...ResourceOption) (*OidcApp, error)
    public static OidcApp Get(string name, Input<string> id, OidcAppState? state, CustomResourceOptions? opts = null)
    public static OidcApp get(String name, Output<String> id, OidcAppState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:OidcApp    get:      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:
    Accessibility string
    For personal password manager
    Audience string
    A comma separated list of allowed audiences
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    ItemCustomFields Dictionary<string, string>
    Additional custom fields to associate with the item
    Key string
    The name of a key that used to encrypt the OIDC application (if empty, the account default protectionKey key will be used)
    Name string
    OIDC App name
    OidcAppId string
    The ID of this resource.
    PermissionAssignment string
    A json array string defining the access permission assignment for this OIDC app. Supports two formats: 1) Auth method: [{"assignmenttype":"AUTHMETHOD","accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}] 2) Group: [{"assignmenttype":"GROUP","groupid":"grp-xyz789"}]
    Public bool
    Set to true if the app is public (cannot keep secrets)
    RedirectUris List<string>
    A comma separated list of allowed redirect uris
    Scopes List<string>
    A comma separated list of allowed scopes
    Tags List<string>
    Add tags attached to this object
    Accessibility string
    For personal password manager
    Audience string
    A comma separated list of allowed audiences
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    ItemCustomFields map[string]string
    Additional custom fields to associate with the item
    Key string
    The name of a key that used to encrypt the OIDC application (if empty, the account default protectionKey key will be used)
    Name string
    OIDC App name
    OidcAppId string
    The ID of this resource.
    PermissionAssignment string
    A json array string defining the access permission assignment for this OIDC app. Supports two formats: 1) Auth method: [{"assignmenttype":"AUTHMETHOD","accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}] 2) Group: [{"assignmenttype":"GROUP","groupid":"grp-xyz789"}]
    Public bool
    Set to true if the app is public (cannot keep secrets)
    RedirectUris []string
    A comma separated list of allowed redirect uris
    Scopes []string
    A comma separated list of allowed scopes
    Tags []string
    Add tags attached to this object
    accessibility String
    For personal password manager
    audience String
    A comma separated list of allowed audiences
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    itemCustomFields Map<String,String>
    Additional custom fields to associate with the item
    key String
    The name of a key that used to encrypt the OIDC application (if empty, the account default protectionKey key will be used)
    name String
    OIDC App name
    oidcAppId String
    The ID of this resource.
    permissionAssignment String
    A json array string defining the access permission assignment for this OIDC app. Supports two formats: 1) Auth method: [{"assignmenttype":"AUTHMETHOD","accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}] 2) Group: [{"assignmenttype":"GROUP","groupid":"grp-xyz789"}]
    public_ Boolean
    Set to true if the app is public (cannot keep secrets)
    redirectUris List<String>
    A comma separated list of allowed redirect uris
    scopes List<String>
    A comma separated list of allowed scopes
    tags List<String>
    Add tags attached to this object
    accessibility string
    For personal password manager
    audience string
    A comma separated list of allowed audiences
    deleteProtection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    itemCustomFields {[key: string]: string}
    Additional custom fields to associate with the item
    key string
    The name of a key that used to encrypt the OIDC application (if empty, the account default protectionKey key will be used)
    name string
    OIDC App name
    oidcAppId string
    The ID of this resource.
    permissionAssignment string
    A json array string defining the access permission assignment for this OIDC app. Supports two formats: 1) Auth method: [{"assignmenttype":"AUTHMETHOD","accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}] 2) Group: [{"assignmenttype":"GROUP","groupid":"grp-xyz789"}]
    public boolean
    Set to true if the app is public (cannot keep secrets)
    redirectUris string[]
    A comma separated list of allowed redirect uris
    scopes string[]
    A comma separated list of allowed scopes
    tags string[]
    Add tags attached to this object
    accessibility str
    For personal password manager
    audience str
    A comma separated list of allowed audiences
    delete_protection str
    Protection from accidental deletion of this object [true/false]
    description str
    Description of the object
    item_custom_fields Mapping[str, str]
    Additional custom fields to associate with the item
    key str
    The name of a key that used to encrypt the OIDC application (if empty, the account default protectionKey key will be used)
    name str
    OIDC App name
    oidc_app_id str
    The ID of this resource.
    permission_assignment str
    A json array string defining the access permission assignment for this OIDC app. Supports two formats: 1) Auth method: [{"assignmenttype":"AUTHMETHOD","accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}] 2) Group: [{"assignmenttype":"GROUP","groupid":"grp-xyz789"}]
    public bool
    Set to true if the app is public (cannot keep secrets)
    redirect_uris Sequence[str]
    A comma separated list of allowed redirect uris
    scopes Sequence[str]
    A comma separated list of allowed scopes
    tags Sequence[str]
    Add tags attached to this object
    accessibility String
    For personal password manager
    audience String
    A comma separated list of allowed audiences
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    itemCustomFields Map<String>
    Additional custom fields to associate with the item
    key String
    The name of a key that used to encrypt the OIDC application (if empty, the account default protectionKey key will be used)
    name String
    OIDC App name
    oidcAppId String
    The ID of this resource.
    permissionAssignment String
    A json array string defining the access permission assignment for this OIDC app. Supports two formats: 1) Auth method: [{"assignmenttype":"AUTHMETHOD","accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}] 2) Group: [{"assignmenttype":"GROUP","groupid":"grp-xyz789"}]
    public Boolean
    Set to true if the app is public (cannot keep secrets)
    redirectUris List<String>
    A comma separated list of allowed redirect uris
    scopes List<String>
    A comma separated list of allowed scopes
    tags List<String>
    Add tags attached to this object

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    Viewing docs for akeyless 2.0.1
    published on Monday, Apr 27, 2026 by akeyless-community
    Schema (JSON)
    akeyless-community/terraform-provider-akeyless
      Try Pulumi Cloud free. Your team will thank you.