1. Packages
  2. Hsdp Provider
  3. API Docs
  4. getIamClient
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software

hsdp.getIamClient

Explore with Pulumi AI

hsdp logo
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software

    Retrieve details of an existing OAuth client

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as hsdp from "@pulumi/hsdp";
    
    const myClient = hsdp.getIamClient({
        name: "MYCLIENT",
        applicationId: data.hsdp_iam_appliation.my_app.id,
    });
    
    import pulumi
    import pulumi_hsdp as hsdp
    
    my_client = hsdp.get_iam_client(name="MYCLIENT",
        application_id=data["hsdp_iam_appliation"]["my_app"]["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/hsdp/hsdp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := hsdp.LookupIamClient(ctx, &hsdp.LookupIamClientArgs{
    			Name:          "MYCLIENT",
    			ApplicationId: data.Hsdp_iam_appliation.My_app.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Hsdp = Pulumi.Hsdp;
    
    return await Deployment.RunAsync(() => 
    {
        var myClient = Hsdp.GetIamClient.Invoke(new()
        {
            Name = "MYCLIENT",
            ApplicationId = data.Hsdp_iam_appliation.My_app.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.hsdp.HsdpFunctions;
    import com.pulumi.hsdp.inputs.GetIamClientArgs;
    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 myClient = HsdpFunctions.getIamClient(GetIamClientArgs.builder()
                .name("MYCLIENT")
                .applicationId(data.hsdp_iam_appliation().my_app().id())
                .build());
    
        }
    }
    
    variables:
      myClient:
        fn::invoke:
          function: hsdp:getIamClient
          arguments:
            name: MYCLIENT
            applicationId: ${data.hsdp_iam_appliation.my_app.id}
    
    import * as pulumi from "@pulumi/pulumi";
    
    export const myClientId = data.hsdp_iam_client.my_client.id;
    
    import pulumi
    
    pulumi.export("myClientId", data["hsdp_iam_client"]["my_client"]["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		ctx.Export("myClientId", data.Hsdp_iam_client.My_client.Id)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    
    return await Deployment.RunAsync(() => 
    {
        return new Dictionary<string, object?>
        {
            ["myClientId"] = data.Hsdp_iam_client.My_client.Id,
        };
    });
    
    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) {
            ctx.export("myClientId", data.hsdp_iam_client().my_client().id());
        }
    }
    
    outputs:
      myClientId: ${data.hsdp_iam_client.my_client.id}
    

    Using getIamClient

    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 getIamClient(args: GetIamClientArgs, opts?: InvokeOptions): Promise<GetIamClientResult>
    function getIamClientOutput(args: GetIamClientOutputArgs, opts?: InvokeOptions): Output<GetIamClientResult>
    def get_iam_client(application_id: Optional[str] = None,
                       id: Optional[str] = None,
                       name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetIamClientResult
    def get_iam_client_output(application_id: Optional[pulumi.Input[str]] = None,
                       id: Optional[pulumi.Input[str]] = None,
                       name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetIamClientResult]
    func LookupIamClient(ctx *Context, args *LookupIamClientArgs, opts ...InvokeOption) (*LookupIamClientResult, error)
    func LookupIamClientOutput(ctx *Context, args *LookupIamClientOutputArgs, opts ...InvokeOption) LookupIamClientResultOutput

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

    public static class GetIamClient 
    {
        public static Task<GetIamClientResult> InvokeAsync(GetIamClientArgs args, InvokeOptions? opts = null)
        public static Output<GetIamClientResult> Invoke(GetIamClientInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIamClientResult> getIamClient(GetIamClientArgs args, InvokeOptions options)
    public static Output<GetIamClientResult> getIamClient(GetIamClientArgs args, InvokeOptions options)
    
    fn::invoke:
      function: hsdp:index/getIamClient:getIamClient
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ApplicationId string
    the UUID of the application the client belongs to
    Name string
    The name of the application to look up
    Id string
    ApplicationId string
    the UUID of the application the client belongs to
    Name string
    The name of the application to look up
    Id string
    applicationId String
    the UUID of the application the client belongs to
    name String
    The name of the application to look up
    id String
    applicationId string
    the UUID of the application the client belongs to
    name string
    The name of the application to look up
    id string
    application_id str
    the UUID of the application the client belongs to
    name str
    The name of the application to look up
    id str
    applicationId String
    the UUID of the application the client belongs to
    name String
    The name of the application to look up
    id String

    getIamClient Result

    The following output properties are available:

    AccessTokenLifetime double
    Lifetime of the access token in seconds
    ApplicationId string
    ClientId string
    The client id
    ConsentImplied bool
    Flag when enabled, the resource owner will not be asked for consent during authorization flows.
    DefaultScopes List<string>
    Array. Default scopes. You do not have to specify these explicitly when requesting a token
    Description string
    The description of the application
    Disabled bool
    GlobalReferenceId string
    The global reference ID of the application
    Id string
    IdTokenLifetime double
    (Optional) Lifetime of the jwt token generated in case openid scope is enabled for the client.
    Name string
    RedirectionUris List<string>
    Array of valid RedirectionURIs for this client
    RefreshTokenLifetime double
    Lifetime of the refresh token in seconds
    ResponseTypes List<string>
    Array. Examples of response types are "code id_token", "token id_token", etc.
    Scopes List<string>
    Array. List of supported scopes for this client
    Type string
    Either Public or Confidential
    AccessTokenLifetime float64
    Lifetime of the access token in seconds
    ApplicationId string
    ClientId string
    The client id
    ConsentImplied bool
    Flag when enabled, the resource owner will not be asked for consent during authorization flows.
    DefaultScopes []string
    Array. Default scopes. You do not have to specify these explicitly when requesting a token
    Description string
    The description of the application
    Disabled bool
    GlobalReferenceId string
    The global reference ID of the application
    Id string
    IdTokenLifetime float64
    (Optional) Lifetime of the jwt token generated in case openid scope is enabled for the client.
    Name string
    RedirectionUris []string
    Array of valid RedirectionURIs for this client
    RefreshTokenLifetime float64
    Lifetime of the refresh token in seconds
    ResponseTypes []string
    Array. Examples of response types are "code id_token", "token id_token", etc.
    Scopes []string
    Array. List of supported scopes for this client
    Type string
    Either Public or Confidential
    accessTokenLifetime Double
    Lifetime of the access token in seconds
    applicationId String
    clientId String
    The client id
    consentImplied Boolean
    Flag when enabled, the resource owner will not be asked for consent during authorization flows.
    defaultScopes List<String>
    Array. Default scopes. You do not have to specify these explicitly when requesting a token
    description String
    The description of the application
    disabled Boolean
    globalReferenceId String
    The global reference ID of the application
    id String
    idTokenLifetime Double
    (Optional) Lifetime of the jwt token generated in case openid scope is enabled for the client.
    name String
    redirectionUris List<String>
    Array of valid RedirectionURIs for this client
    refreshTokenLifetime Double
    Lifetime of the refresh token in seconds
    responseTypes List<String>
    Array. Examples of response types are "code id_token", "token id_token", etc.
    scopes List<String>
    Array. List of supported scopes for this client
    type String
    Either Public or Confidential
    accessTokenLifetime number
    Lifetime of the access token in seconds
    applicationId string
    clientId string
    The client id
    consentImplied boolean
    Flag when enabled, the resource owner will not be asked for consent during authorization flows.
    defaultScopes string[]
    Array. Default scopes. You do not have to specify these explicitly when requesting a token
    description string
    The description of the application
    disabled boolean
    globalReferenceId string
    The global reference ID of the application
    id string
    idTokenLifetime number
    (Optional) Lifetime of the jwt token generated in case openid scope is enabled for the client.
    name string
    redirectionUris string[]
    Array of valid RedirectionURIs for this client
    refreshTokenLifetime number
    Lifetime of the refresh token in seconds
    responseTypes string[]
    Array. Examples of response types are "code id_token", "token id_token", etc.
    scopes string[]
    Array. List of supported scopes for this client
    type string
    Either Public or Confidential
    access_token_lifetime float
    Lifetime of the access token in seconds
    application_id str
    client_id str
    The client id
    consent_implied bool
    Flag when enabled, the resource owner will not be asked for consent during authorization flows.
    default_scopes Sequence[str]
    Array. Default scopes. You do not have to specify these explicitly when requesting a token
    description str
    The description of the application
    disabled bool
    global_reference_id str
    The global reference ID of the application
    id str
    id_token_lifetime float
    (Optional) Lifetime of the jwt token generated in case openid scope is enabled for the client.
    name str
    redirection_uris Sequence[str]
    Array of valid RedirectionURIs for this client
    refresh_token_lifetime float
    Lifetime of the refresh token in seconds
    response_types Sequence[str]
    Array. Examples of response types are "code id_token", "token id_token", etc.
    scopes Sequence[str]
    Array. List of supported scopes for this client
    type str
    Either Public or Confidential
    accessTokenLifetime Number
    Lifetime of the access token in seconds
    applicationId String
    clientId String
    The client id
    consentImplied Boolean
    Flag when enabled, the resource owner will not be asked for consent during authorization flows.
    defaultScopes List<String>
    Array. Default scopes. You do not have to specify these explicitly when requesting a token
    description String
    The description of the application
    disabled Boolean
    globalReferenceId String
    The global reference ID of the application
    id String
    idTokenLifetime Number
    (Optional) Lifetime of the jwt token generated in case openid scope is enabled for the client.
    name String
    redirectionUris List<String>
    Array of valid RedirectionURIs for this client
    refreshTokenLifetime Number
    Lifetime of the refresh token in seconds
    responseTypes List<String>
    Array. Examples of response types are "code id_token", "token id_token", etc.
    scopes List<String>
    Array. List of supported scopes for this client
    type String
    Either Public or Confidential

    Package Details

    Repository
    hsdp philips-software/terraform-provider-hsdp
    License
    Notes
    This Pulumi package is based on the hsdp Terraform Provider.
    hsdp logo
    hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software