okta.AppOauthApiScope
Explore with Pulumi AI
Manages API scopes for OAuth applications.
This resource allows you to grant or revoke API scopes for OAuth2 applications within your organization.
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic;
using System.Linq;
using Pulumi;
return await Deployment.RunAsync(() =>
{
});
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
}
}
{}
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Okta = Pulumi.Okta;
return await Deployment.RunAsync(() =>
{
var example = new Okta.AppOauthApiScope("example", new()
{
AppId = "<application_id>",
Issuer = "<your org domain>",
Scopes = new[]
{
"okta.users.read",
"okta.users.manage",
},
});
});
package main
import (
"github.com/pulumi/pulumi-okta/sdk/v3/go/okta"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := okta.NewAppOauthApiScope(ctx, "example", &okta.AppOauthApiScopeArgs{
AppId: pulumi.String("<application_id>"),
Issuer: pulumi.String("<your org domain>"),
Scopes: pulumi.StringArray{
pulumi.String("okta.users.read"),
pulumi.String("okta.users.manage"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.AppOauthApiScope;
import com.pulumi.okta.AppOauthApiScopeArgs;
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) {
var example = new AppOauthApiScope("example", AppOauthApiScopeArgs.builder()
.appId("<application_id>")
.issuer("<your org domain>")
.scopes(
"okta.users.read",
"okta.users.manage")
.build());
}
}
import pulumi
import pulumi_okta as okta
example = okta.AppOauthApiScope("example",
app_id="<application_id>",
issuer="<your org domain>",
scopes=[
"okta.users.read",
"okta.users.manage",
])
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";
const example = new okta.AppOauthApiScope("example", {
appId: "<application_id>",
issuer: "<your org domain>",
scopes: [
"okta.users.read",
"okta.users.manage",
],
});
resources:
example:
type: okta:AppOauthApiScope
properties:
appId: <application_id>
issuer: <your org domain>
scopes:
- okta.users.read
- okta.users.manage
Create AppOauthApiScope Resource
new AppOauthApiScope(name: string, args: AppOauthApiScopeArgs, opts?: CustomResourceOptions);
@overload
def AppOauthApiScope(resource_name: str,
opts: Optional[ResourceOptions] = None,
app_id: Optional[str] = None,
issuer: Optional[str] = None,
scopes: Optional[Sequence[str]] = None)
@overload
def AppOauthApiScope(resource_name: str,
args: AppOauthApiScopeArgs,
opts: Optional[ResourceOptions] = None)
func NewAppOauthApiScope(ctx *Context, name string, args AppOauthApiScopeArgs, opts ...ResourceOption) (*AppOauthApiScope, error)
public AppOauthApiScope(string name, AppOauthApiScopeArgs args, CustomResourceOptions? opts = null)
public AppOauthApiScope(String name, AppOauthApiScopeArgs args)
public AppOauthApiScope(String name, AppOauthApiScopeArgs args, CustomResourceOptions options)
type: okta:AppOauthApiScope
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AppOauthApiScopeArgs
- 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 AppOauthApiScopeArgs
- 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 AppOauthApiScopeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AppOauthApiScopeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AppOauthApiScopeArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
AppOauthApiScope Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The AppOauthApiScope resource accepts the following input properties:
Outputs
All input properties are implicitly available as output properties. Additionally, the AppOauthApiScope 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 AppOauthApiScope Resource
Get an existing AppOauthApiScope 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?: AppOauthApiScopeState, opts?: CustomResourceOptions): AppOauthApiScope
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
app_id: Optional[str] = None,
issuer: Optional[str] = None,
scopes: Optional[Sequence[str]] = None) -> AppOauthApiScope
func GetAppOauthApiScope(ctx *Context, name string, id IDInput, state *AppOauthApiScopeState, opts ...ResourceOption) (*AppOauthApiScope, error)
public static AppOauthApiScope Get(string name, Input<string> id, AppOauthApiScopeState? state, CustomResourceOptions? opts = null)
public static AppOauthApiScope get(String name, Output<String> id, AppOauthApiScopeState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
Import
OAuth API scopes can be imported via the Okta Application ID.
$ pulumi import okta:index/appOauthApiScope:AppOauthApiScope example <app id>
Package Details
- Repository
- Okta pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
okta
Terraform Provider.