1. Packages
  2. Keycloak
  3. API Docs
  4. saml
  5. ClientDefaultScope
Keycloak v5.3.2 published on Friday, May 10, 2024 by Pulumi

keycloak.saml.ClientDefaultScope

Explore with Pulumi AI

keycloak logo
Keycloak v5.3.2 published on Friday, May 10, 2024 by Pulumi

    Example Usage

    Create ClientDefaultScope Resource

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

    Constructor syntax

    new ClientDefaultScope(name: string, args: ClientDefaultScopeArgs, opts?: CustomResourceOptions);
    @overload
    def ClientDefaultScope(resource_name: str,
                           args: ClientDefaultScopeArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def ClientDefaultScope(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           client_id: Optional[str] = None,
                           default_scopes: Optional[Sequence[str]] = None,
                           realm_id: Optional[str] = None)
    func NewClientDefaultScope(ctx *Context, name string, args ClientDefaultScopeArgs, opts ...ResourceOption) (*ClientDefaultScope, error)
    public ClientDefaultScope(string name, ClientDefaultScopeArgs args, CustomResourceOptions? opts = null)
    public ClientDefaultScope(String name, ClientDefaultScopeArgs args)
    public ClientDefaultScope(String name, ClientDefaultScopeArgs args, CustomResourceOptions options)
    
    type: keycloak:saml:ClientDefaultScope
    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 ClientDefaultScopeArgs
    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 ClientDefaultScopeArgs
    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 ClientDefaultScopeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClientDefaultScopeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClientDefaultScopeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var clientDefaultScopeResource = new Keycloak.Saml.ClientDefaultScope("clientDefaultScopeResource", new()
    {
        ClientId = "string",
        DefaultScopes = new[]
        {
            "string",
        },
        RealmId = "string",
    });
    
    example, err := saml.NewClientDefaultScope(ctx, "clientDefaultScopeResource", &saml.ClientDefaultScopeArgs{
    	ClientId: pulumi.String("string"),
    	DefaultScopes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	RealmId: pulumi.String("string"),
    })
    
    var clientDefaultScopeResource = new ClientDefaultScope("clientDefaultScopeResource", ClientDefaultScopeArgs.builder()
        .clientId("string")
        .defaultScopes("string")
        .realmId("string")
        .build());
    
    client_default_scope_resource = keycloak.saml.ClientDefaultScope("clientDefaultScopeResource",
        client_id="string",
        default_scopes=["string"],
        realm_id="string")
    
    const clientDefaultScopeResource = new keycloak.saml.ClientDefaultScope("clientDefaultScopeResource", {
        clientId: "string",
        defaultScopes: ["string"],
        realmId: "string",
    });
    
    type: keycloak:saml:ClientDefaultScope
    properties:
        clientId: string
        defaultScopes:
            - string
        realmId: string
    

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

    ClientId string
    The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.
    DefaultScopes List<string>
    An array of client scope names to attach to this client.
    RealmId string
    The realm this client and scopes exists in.
    ClientId string
    The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.
    DefaultScopes []string
    An array of client scope names to attach to this client.
    RealmId string
    The realm this client and scopes exists in.
    clientId String
    The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.
    defaultScopes List<String>
    An array of client scope names to attach to this client.
    realmId String
    The realm this client and scopes exists in.
    clientId string
    The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.
    defaultScopes string[]
    An array of client scope names to attach to this client.
    realmId string
    The realm this client and scopes exists in.
    client_id str
    The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.
    default_scopes Sequence[str]
    An array of client scope names to attach to this client.
    realm_id str
    The realm this client and scopes exists in.
    clientId String
    The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.
    defaultScopes List<String>
    An array of client scope names to attach to this client.
    realmId String
    The realm this client and scopes exists in.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ClientDefaultScope 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 ClientDefaultScope Resource

    Get an existing ClientDefaultScope 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?: ClientDefaultScopeState, opts?: CustomResourceOptions): ClientDefaultScope
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            client_id: Optional[str] = None,
            default_scopes: Optional[Sequence[str]] = None,
            realm_id: Optional[str] = None) -> ClientDefaultScope
    func GetClientDefaultScope(ctx *Context, name string, id IDInput, state *ClientDefaultScopeState, opts ...ResourceOption) (*ClientDefaultScope, error)
    public static ClientDefaultScope Get(string name, Input<string> id, ClientDefaultScopeState? state, CustomResourceOptions? opts = null)
    public static ClientDefaultScope get(String name, Output<String> id, ClientDefaultScopeState 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.
    The following state arguments are supported:
    ClientId string
    The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.
    DefaultScopes List<string>
    An array of client scope names to attach to this client.
    RealmId string
    The realm this client and scopes exists in.
    ClientId string
    The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.
    DefaultScopes []string
    An array of client scope names to attach to this client.
    RealmId string
    The realm this client and scopes exists in.
    clientId String
    The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.
    defaultScopes List<String>
    An array of client scope names to attach to this client.
    realmId String
    The realm this client and scopes exists in.
    clientId string
    The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.
    defaultScopes string[]
    An array of client scope names to attach to this client.
    realmId string
    The realm this client and scopes exists in.
    client_id str
    The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.
    default_scopes Sequence[str]
    An array of client scope names to attach to this client.
    realm_id str
    The realm this client and scopes exists in.
    clientId String
    The ID of the client to attach default scopes to. Note that this is the unique ID of the client generated by Keycloak.
    defaultScopes List<String>
    An array of client scope names to attach to this client.
    realmId String
    The realm this client and scopes exists in.

    Package Details

    Repository
    Keycloak pulumi/pulumi-keycloak
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the keycloak Terraform Provider.
    keycloak logo
    Keycloak v5.3.2 published on Friday, May 10, 2024 by Pulumi