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

hsdp.IamService

Explore with Pulumi AI

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

    Provides a resource for managing HSDP IAM services of an application under a proposition.

    Example Usage

    The following example creates a service

    import * as pulumi from "@pulumi/pulumi";
    import * as hsdp from "@pulumi/hsdp";
    
    const testservice = new hsdp.IamService("testservice", {
        description: "Test service",
        applicationId: _var.app_id,
        validity: 12,
        tokenValidity: 3600,
        scopes: ["openid"],
        defaultScopes: ["openid"],
    });
    
    import pulumi
    import pulumi_hsdp as hsdp
    
    testservice = hsdp.IamService("testservice",
        description="Test service",
        application_id=var["app_id"],
        validity=12,
        token_validity=3600,
        scopes=["openid"],
        default_scopes=["openid"])
    
    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.NewIamService(ctx, "testservice", &hsdp.IamServiceArgs{
    			Description:   pulumi.String("Test service"),
    			ApplicationId: pulumi.Any(_var.App_id),
    			Validity:      pulumi.Float64(12),
    			TokenValidity: pulumi.Float64(3600),
    			Scopes: pulumi.StringArray{
    				pulumi.String("openid"),
    			},
    			DefaultScopes: pulumi.StringArray{
    				pulumi.String("openid"),
    			},
    		})
    		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 testservice = new Hsdp.IamService("testservice", new()
        {
            Description = "Test service",
            ApplicationId = @var.App_id,
            Validity = 12,
            TokenValidity = 3600,
            Scopes = new[]
            {
                "openid",
            },
            DefaultScopes = new[]
            {
                "openid",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.hsdp.IamService;
    import com.pulumi.hsdp.IamServiceArgs;
    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 testservice = new IamService("testservice", IamServiceArgs.builder()
                .description("Test service")
                .applicationId(var_.app_id())
                .validity(12)
                .tokenValidity(3600)
                .scopes("openid")
                .defaultScopes("openid")
                .build());
    
        }
    }
    
    resources:
      testservice:
        type: hsdp:IamService
        properties:
          description: Test service
          applicationId: ${var.app_id}
          validity: 12 # Months
          tokenValidity: 3600 # Seconds
          scopes:
            - openid
          defaultScopes:
            - openid
    

    The followin example creates a service with an external managed certificate

    import * as pulumi from "@pulumi/pulumi";
    import * as hsdp from "@pulumi/hsdp";
    import * as tls from "@pulumi/tls";
    
    const testservicetls_private_key = new tls.index.Tls_private_key("testservicetls_private_key", {
        algorithm: "RSA",
        rsaBits: 4096,
    });
    const testservicetls_self_signed_cert = new tls.index.Tls_self_signed_cert("testservicetls_self_signed_cert", {
        privateKeyPem: testservicetls_private_key.privateKeyPem,
        subject: [{
            commonName: "testservice.",
        }],
        validityPeriodHours: 24,
        allowedUses: [],
    });
    const testserviceIamService = new hsdp.IamService("testserviceIamService", {
        description: "Test service",
        applicationId: _var.app_id,
        validity: 12,
        tokenValidity: 3600,
        scopes: ["openid"],
        defaultScopes: ["openid"],
        selfManagedCertificate: testservicetls_self_signed_cert.certPem,
    });
    
    import pulumi
    import pulumi_hsdp as hsdp
    import pulumi_tls as tls
    
    testservicetls_private_key = tls.index.Tls_private_key("testservicetls_private_key",
        algorithm=RSA,
        rsa_bits=4096)
    testservicetls_self_signed_cert = tls.index.Tls_self_signed_cert("testservicetls_self_signed_cert",
        private_key_pem=testservicetls_private_key.private_key_pem,
        subject=[{
            commonName: testservice.,
        }],
        validity_period_hours=24,
        allowed_uses=[])
    testservice_iam_service = hsdp.IamService("testserviceIamService",
        description="Test service",
        application_id=var["app_id"],
        validity=12,
        token_validity=3600,
        scopes=["openid"],
        default_scopes=["openid"],
        self_managed_certificate=testservicetls_self_signed_cert["certPem"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/hsdp/hsdp"
    	"github.com/pulumi/pulumi-tls/sdk/go/tls"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		testservicetls_private_key, err := tls.NewTls_private_key(ctx, "testservicetls_private_key", &tls.Tls_private_keyArgs{
    			Algorithm: "RSA",
    			RsaBits:   4096,
    		})
    		if err != nil {
    			return err
    		}
    		testservicetls_self_signed_cert, err := tls.NewTls_self_signed_cert(ctx, "testservicetls_self_signed_cert", &tls.Tls_self_signed_certArgs{
    			PrivateKeyPem: testservicetls_private_key.PrivateKeyPem,
    			Subject: []map[string]interface{}{
    				map[string]interface{}{
    					"commonName": "testservice.",
    				},
    			},
    			ValidityPeriodHours: 24,
    			AllowedUses:         []interface{}{},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = hsdp.NewIamService(ctx, "testserviceIamService", &hsdp.IamServiceArgs{
    			Description:   pulumi.String("Test service"),
    			ApplicationId: pulumi.Any(_var.App_id),
    			Validity:      pulumi.Float64(12),
    			TokenValidity: pulumi.Float64(3600),
    			Scopes: pulumi.StringArray{
    				pulumi.String("openid"),
    			},
    			DefaultScopes: pulumi.StringArray{
    				pulumi.String("openid"),
    			},
    			SelfManagedCertificate: testservicetls_self_signed_cert.CertPem,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Hsdp = Pulumi.Hsdp;
    using Tls = Pulumi.Tls;
    
    return await Deployment.RunAsync(() => 
    {
        var testservicetls_private_key = new Tls.Index.Tls_private_key("testservicetls_private_key", new()
        {
            Algorithm = "RSA",
            RsaBits = 4096,
        });
    
        var testservicetls_self_signed_cert = new Tls.Index.Tls_self_signed_cert("testservicetls_self_signed_cert", new()
        {
            PrivateKeyPem = testservicetls_private_key.PrivateKeyPem,
            Subject = new[]
            {
                
                {
                    { "commonName", "testservice." },
                },
            },
            ValidityPeriodHours = 24,
            AllowedUses = new[] {},
        });
    
        var testserviceIamService = new Hsdp.IamService("testserviceIamService", new()
        {
            Description = "Test service",
            ApplicationId = @var.App_id,
            Validity = 12,
            TokenValidity = 3600,
            Scopes = new[]
            {
                "openid",
            },
            DefaultScopes = new[]
            {
                "openid",
            },
            SelfManagedCertificate = testservicetls_self_signed_cert.CertPem,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.tls.tls_private_key;
    import com.pulumi.tls.Tls_private_keyArgs;
    import com.pulumi.tls.tls_self_signed_cert;
    import com.pulumi.tls.Tls_self_signed_certArgs;
    import com.pulumi.hsdp.IamService;
    import com.pulumi.hsdp.IamServiceArgs;
    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 testservicetls_private_key = new Tls_private_key("testservicetls_private_key", Tls_private_keyArgs.builder()
                .algorithm("RSA")
                .rsaBits(4096)
                .build());
    
            var testservicetls_self_signed_cert = new Tls_self_signed_cert("testservicetls_self_signed_cert", Tls_self_signed_certArgs.builder()
                .privateKeyPem(testservicetls_private_key.privateKeyPem())
                .subject(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .validityPeriodHours(24)
                .allowedUses()
                .build());
    
            var testserviceIamService = new IamService("testserviceIamService", IamServiceArgs.builder()
                .description("Test service")
                .applicationId(var_.app_id())
                .validity(12)
                .tokenValidity(3600)
                .scopes("openid")
                .defaultScopes("openid")
                .selfManagedCertificate(testservicetls_self_signed_cert.certPem())
                .build());
    
        }
    }
    
    resources:
      testservicetls_private_key:
        type: tls:tls_private_key
        properties:
          algorithm: RSA
          rsaBits: 4096
      testservicetls_self_signed_cert:
        type: tls:tls_self_signed_cert
        properties:
          privateKeyPem: ${testservicetls_private_key.privateKeyPem}
          subject:
            - commonName: testservice.
          validityPeriodHours: 24
          allowedUses: []
      testserviceIamService:
        type: hsdp:IamService
        properties:
          description: Test service
          applicationId: ${var.app_id}
          validity: 12 # Months
          tokenValidity: 3600 # Seconds
          scopes:
            - openid
          defaultScopes:
            - openid
          selfManagedCertificate: ${testservicetls_self_signed_cert.certPem}
    

    Create IamService Resource

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

    Constructor syntax

    new IamService(name: string, args: IamServiceArgs, opts?: CustomResourceOptions);
    @overload
    def IamService(resource_name: str,
                   args: IamServiceArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def IamService(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   application_id: Optional[str] = None,
                   default_scopes: Optional[Sequence[str]] = None,
                   description: Optional[str] = None,
                   scopes: Optional[Sequence[str]] = None,
                   iam_service_id: Optional[str] = None,
                   name: Optional[str] = None,
                   self_managed_certificate: Optional[str] = None,
                   self_managed_certificate_nonsensitive: Optional[str] = None,
                   self_managed_expires_on: Optional[str] = None,
                   self_managed_private_key: Optional[str] = None,
                   token_validity: Optional[float] = None,
                   validity: Optional[float] = None)
    func NewIamService(ctx *Context, name string, args IamServiceArgs, opts ...ResourceOption) (*IamService, error)
    public IamService(string name, IamServiceArgs args, CustomResourceOptions? opts = null)
    public IamService(String name, IamServiceArgs args)
    public IamService(String name, IamServiceArgs args, CustomResourceOptions options)
    
    type: hsdp:IamService
    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 IamServiceArgs
    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 IamServiceArgs
    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 IamServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IamServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IamServiceArgs
    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 iamServiceResource = new Hsdp.IamService("iamServiceResource", new()
    {
        ApplicationId = "string",
        DefaultScopes = new[]
        {
            "string",
        },
        Description = "string",
        Scopes = new[]
        {
            "string",
        },
        IamServiceId = "string",
        Name = "string",
        SelfManagedCertificate = "string",
        SelfManagedCertificateNonsensitive = "string",
        TokenValidity = 0,
        Validity = 0,
    });
    
    example, err := hsdp.NewIamService(ctx, "iamServiceResource", &hsdp.IamServiceArgs{
    	ApplicationId: pulumi.String("string"),
    	DefaultScopes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description: pulumi.String("string"),
    	Scopes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	IamServiceId:                       pulumi.String("string"),
    	Name:                               pulumi.String("string"),
    	SelfManagedCertificate:             pulumi.String("string"),
    	SelfManagedCertificateNonsensitive: pulumi.String("string"),
    	TokenValidity:                      pulumi.Float64(0),
    	Validity:                           pulumi.Float64(0),
    })
    
    var iamServiceResource = new IamService("iamServiceResource", IamServiceArgs.builder()
        .applicationId("string")
        .defaultScopes("string")
        .description("string")
        .scopes("string")
        .iamServiceId("string")
        .name("string")
        .selfManagedCertificate("string")
        .selfManagedCertificateNonsensitive("string")
        .tokenValidity(0)
        .validity(0)
        .build());
    
    iam_service_resource = hsdp.IamService("iamServiceResource",
        application_id="string",
        default_scopes=["string"],
        description="string",
        scopes=["string"],
        iam_service_id="string",
        name="string",
        self_managed_certificate="string",
        self_managed_certificate_nonsensitive="string",
        token_validity=0,
        validity=0)
    
    const iamServiceResource = new hsdp.IamService("iamServiceResource", {
        applicationId: "string",
        defaultScopes: ["string"],
        description: "string",
        scopes: ["string"],
        iamServiceId: "string",
        name: "string",
        selfManagedCertificate: "string",
        selfManagedCertificateNonsensitive: "string",
        tokenValidity: 0,
        validity: 0,
    });
    
    type: hsdp:IamService
    properties:
        applicationId: string
        defaultScopes:
            - string
        description: string
        iamServiceId: string
        name: string
        scopes:
            - string
        selfManagedCertificate: string
        selfManagedCertificateNonsensitive: string
        tokenValidity: 0
        validity: 0
    

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

    ApplicationId string
    the application ID (GUID) to attach this service to
    DefaultScopes List<string>
    Array. Default scopes. You do not have to specify these explicitly when requesting a token. Minimum: ["openid"]
    Description string
    The description of the service
    Scopes List<string>
    Array. List of supported scopes for this service. Minimum: ["openid"]
    IamServiceId string
    The GUID of the client
    Name string
    The name of the service
    SelfManagedCertificate string
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    SelfManagedCertificateNonsensitive string
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    SelfManagedExpiresOn string
    Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.

    Deprecated: Deprecated

    SelfManagedPrivateKey string
    RSA private key in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM

    Deprecated: Deprecated

    TokenValidity double
    Integer. Access Token Lifetime (in seconds). Default: 1800 (30 minutes), Maximum: 2592000 (30 days)
    Validity double
    Integer. Validity of service (in months). Minimum: 1, Maximum: 600 (5 years), Default: 12
    ApplicationId string
    the application ID (GUID) to attach this service to
    DefaultScopes []string
    Array. Default scopes. You do not have to specify these explicitly when requesting a token. Minimum: ["openid"]
    Description string
    The description of the service
    Scopes []string
    Array. List of supported scopes for this service. Minimum: ["openid"]
    IamServiceId string
    The GUID of the client
    Name string
    The name of the service
    SelfManagedCertificate string
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    SelfManagedCertificateNonsensitive string
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    SelfManagedExpiresOn string
    Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.

    Deprecated: Deprecated

    SelfManagedPrivateKey string
    RSA private key in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM

    Deprecated: Deprecated

    TokenValidity float64
    Integer. Access Token Lifetime (in seconds). Default: 1800 (30 minutes), Maximum: 2592000 (30 days)
    Validity float64
    Integer. Validity of service (in months). Minimum: 1, Maximum: 600 (5 years), Default: 12
    applicationId String
    the application ID (GUID) to attach this service to
    defaultScopes List<String>
    Array. Default scopes. You do not have to specify these explicitly when requesting a token. Minimum: ["openid"]
    description String
    The description of the service
    scopes List<String>
    Array. List of supported scopes for this service. Minimum: ["openid"]
    iamServiceId String
    The GUID of the client
    name String
    The name of the service
    selfManagedCertificate String
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    selfManagedCertificateNonsensitive String
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    selfManagedExpiresOn String
    Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.

    Deprecated: Deprecated

    selfManagedPrivateKey String
    RSA private key in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM

    Deprecated: Deprecated

    tokenValidity Double
    Integer. Access Token Lifetime (in seconds). Default: 1800 (30 minutes), Maximum: 2592000 (30 days)
    validity Double
    Integer. Validity of service (in months). Minimum: 1, Maximum: 600 (5 years), Default: 12
    applicationId string
    the application ID (GUID) to attach this service to
    defaultScopes string[]
    Array. Default scopes. You do not have to specify these explicitly when requesting a token. Minimum: ["openid"]
    description string
    The description of the service
    scopes string[]
    Array. List of supported scopes for this service. Minimum: ["openid"]
    iamServiceId string
    The GUID of the client
    name string
    The name of the service
    selfManagedCertificate string
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    selfManagedCertificateNonsensitive string
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    selfManagedExpiresOn string
    Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.

    Deprecated: Deprecated

    selfManagedPrivateKey string
    RSA private key in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM

    Deprecated: Deprecated

    tokenValidity number
    Integer. Access Token Lifetime (in seconds). Default: 1800 (30 minutes), Maximum: 2592000 (30 days)
    validity number
    Integer. Validity of service (in months). Minimum: 1, Maximum: 600 (5 years), Default: 12
    application_id str
    the application ID (GUID) to attach this service to
    default_scopes Sequence[str]
    Array. Default scopes. You do not have to specify these explicitly when requesting a token. Minimum: ["openid"]
    description str
    The description of the service
    scopes Sequence[str]
    Array. List of supported scopes for this service. Minimum: ["openid"]
    iam_service_id str
    The GUID of the client
    name str
    The name of the service
    self_managed_certificate str
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    self_managed_certificate_nonsensitive str
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    self_managed_expires_on str
    Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.

    Deprecated: Deprecated

    self_managed_private_key str
    RSA private key in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM

    Deprecated: Deprecated

    token_validity float
    Integer. Access Token Lifetime (in seconds). Default: 1800 (30 minutes), Maximum: 2592000 (30 days)
    validity float
    Integer. Validity of service (in months). Minimum: 1, Maximum: 600 (5 years), Default: 12
    applicationId String
    the application ID (GUID) to attach this service to
    defaultScopes List<String>
    Array. Default scopes. You do not have to specify these explicitly when requesting a token. Minimum: ["openid"]
    description String
    The description of the service
    scopes List<String>
    Array. List of supported scopes for this service. Minimum: ["openid"]
    iamServiceId String
    The GUID of the client
    name String
    The name of the service
    selfManagedCertificate String
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    selfManagedCertificateNonsensitive String
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    selfManagedExpiresOn String
    Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.

    Deprecated: Deprecated

    selfManagedPrivateKey String
    RSA private key in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM

    Deprecated: Deprecated

    tokenValidity Number
    Integer. Access Token Lifetime (in seconds). Default: 1800 (30 minutes), Maximum: 2592000 (30 days)
    validity Number
    Integer. Validity of service (in months). Minimum: 1, Maximum: 600 (5 years), Default: 12

    Outputs

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

    ExpiresOn string
    (Generated) Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.
    Id string
    The provider-assigned unique ID for this managed resource.
    OrganizationId string
    The organization ID this service belongs to (via application and proposition)
    PrivateKey string
    (Generated) The active private of the service
    ServiceId string
    (Generated) The service id
    ExpiresOn string
    (Generated) Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.
    Id string
    The provider-assigned unique ID for this managed resource.
    OrganizationId string
    The organization ID this service belongs to (via application and proposition)
    PrivateKey string
    (Generated) The active private of the service
    ServiceId string
    (Generated) The service id
    expiresOn String
    (Generated) Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.
    id String
    The provider-assigned unique ID for this managed resource.
    organizationId String
    The organization ID this service belongs to (via application and proposition)
    privateKey String
    (Generated) The active private of the service
    serviceId String
    (Generated) The service id
    expiresOn string
    (Generated) Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.
    id string
    The provider-assigned unique ID for this managed resource.
    organizationId string
    The organization ID this service belongs to (via application and proposition)
    privateKey string
    (Generated) The active private of the service
    serviceId string
    (Generated) The service id
    expires_on str
    (Generated) Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.
    id str
    The provider-assigned unique ID for this managed resource.
    organization_id str
    The organization ID this service belongs to (via application and proposition)
    private_key str
    (Generated) The active private of the service
    service_id str
    (Generated) The service id
    expiresOn String
    (Generated) Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.
    id String
    The provider-assigned unique ID for this managed resource.
    organizationId String
    The organization ID this service belongs to (via application and proposition)
    privateKey String
    (Generated) The active private of the service
    serviceId String
    (Generated) The service id

    Look up Existing IamService Resource

    Get an existing IamService 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?: IamServiceState, opts?: CustomResourceOptions): IamService
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            application_id: Optional[str] = None,
            default_scopes: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            expires_on: Optional[str] = None,
            iam_service_id: Optional[str] = None,
            name: Optional[str] = None,
            organization_id: Optional[str] = None,
            private_key: Optional[str] = None,
            scopes: Optional[Sequence[str]] = None,
            self_managed_certificate: Optional[str] = None,
            self_managed_certificate_nonsensitive: Optional[str] = None,
            self_managed_expires_on: Optional[str] = None,
            self_managed_private_key: Optional[str] = None,
            service_id: Optional[str] = None,
            token_validity: Optional[float] = None,
            validity: Optional[float] = None) -> IamService
    func GetIamService(ctx *Context, name string, id IDInput, state *IamServiceState, opts ...ResourceOption) (*IamService, error)
    public static IamService Get(string name, Input<string> id, IamServiceState? state, CustomResourceOptions? opts = null)
    public static IamService get(String name, Output<String> id, IamServiceState state, CustomResourceOptions options)
    resources:  _:    type: hsdp:IamService    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:
    ApplicationId string
    the application ID (GUID) to attach this service to
    DefaultScopes List<string>
    Array. Default scopes. You do not have to specify these explicitly when requesting a token. Minimum: ["openid"]
    Description string
    The description of the service
    ExpiresOn string
    (Generated) Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.
    IamServiceId string
    The GUID of the client
    Name string
    The name of the service
    OrganizationId string
    The organization ID this service belongs to (via application and proposition)
    PrivateKey string
    (Generated) The active private of the service
    Scopes List<string>
    Array. List of supported scopes for this service. Minimum: ["openid"]
    SelfManagedCertificate string
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    SelfManagedCertificateNonsensitive string
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    SelfManagedExpiresOn string
    Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.

    Deprecated: Deprecated

    SelfManagedPrivateKey string
    RSA private key in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM

    Deprecated: Deprecated

    ServiceId string
    (Generated) The service id
    TokenValidity double
    Integer. Access Token Lifetime (in seconds). Default: 1800 (30 minutes), Maximum: 2592000 (30 days)
    Validity double
    Integer. Validity of service (in months). Minimum: 1, Maximum: 600 (5 years), Default: 12
    ApplicationId string
    the application ID (GUID) to attach this service to
    DefaultScopes []string
    Array. Default scopes. You do not have to specify these explicitly when requesting a token. Minimum: ["openid"]
    Description string
    The description of the service
    ExpiresOn string
    (Generated) Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.
    IamServiceId string
    The GUID of the client
    Name string
    The name of the service
    OrganizationId string
    The organization ID this service belongs to (via application and proposition)
    PrivateKey string
    (Generated) The active private of the service
    Scopes []string
    Array. List of supported scopes for this service. Minimum: ["openid"]
    SelfManagedCertificate string
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    SelfManagedCertificateNonsensitive string
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    SelfManagedExpiresOn string
    Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.

    Deprecated: Deprecated

    SelfManagedPrivateKey string
    RSA private key in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM

    Deprecated: Deprecated

    ServiceId string
    (Generated) The service id
    TokenValidity float64
    Integer. Access Token Lifetime (in seconds). Default: 1800 (30 minutes), Maximum: 2592000 (30 days)
    Validity float64
    Integer. Validity of service (in months). Minimum: 1, Maximum: 600 (5 years), Default: 12
    applicationId String
    the application ID (GUID) to attach this service to
    defaultScopes List<String>
    Array. Default scopes. You do not have to specify these explicitly when requesting a token. Minimum: ["openid"]
    description String
    The description of the service
    expiresOn String
    (Generated) Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.
    iamServiceId String
    The GUID of the client
    name String
    The name of the service
    organizationId String
    The organization ID this service belongs to (via application and proposition)
    privateKey String
    (Generated) The active private of the service
    scopes List<String>
    Array. List of supported scopes for this service. Minimum: ["openid"]
    selfManagedCertificate String
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    selfManagedCertificateNonsensitive String
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    selfManagedExpiresOn String
    Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.

    Deprecated: Deprecated

    selfManagedPrivateKey String
    RSA private key in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM

    Deprecated: Deprecated

    serviceId String
    (Generated) The service id
    tokenValidity Double
    Integer. Access Token Lifetime (in seconds). Default: 1800 (30 minutes), Maximum: 2592000 (30 days)
    validity Double
    Integer. Validity of service (in months). Minimum: 1, Maximum: 600 (5 years), Default: 12
    applicationId string
    the application ID (GUID) to attach this service to
    defaultScopes string[]
    Array. Default scopes. You do not have to specify these explicitly when requesting a token. Minimum: ["openid"]
    description string
    The description of the service
    expiresOn string
    (Generated) Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.
    iamServiceId string
    The GUID of the client
    name string
    The name of the service
    organizationId string
    The organization ID this service belongs to (via application and proposition)
    privateKey string
    (Generated) The active private of the service
    scopes string[]
    Array. List of supported scopes for this service. Minimum: ["openid"]
    selfManagedCertificate string
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    selfManagedCertificateNonsensitive string
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    selfManagedExpiresOn string
    Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.

    Deprecated: Deprecated

    selfManagedPrivateKey string
    RSA private key in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM

    Deprecated: Deprecated

    serviceId string
    (Generated) The service id
    tokenValidity number
    Integer. Access Token Lifetime (in seconds). Default: 1800 (30 minutes), Maximum: 2592000 (30 days)
    validity number
    Integer. Validity of service (in months). Minimum: 1, Maximum: 600 (5 years), Default: 12
    application_id str
    the application ID (GUID) to attach this service to
    default_scopes Sequence[str]
    Array. Default scopes. You do not have to specify these explicitly when requesting a token. Minimum: ["openid"]
    description str
    The description of the service
    expires_on str
    (Generated) Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.
    iam_service_id str
    The GUID of the client
    name str
    The name of the service
    organization_id str
    The organization ID this service belongs to (via application and proposition)
    private_key str
    (Generated) The active private of the service
    scopes Sequence[str]
    Array. List of supported scopes for this service. Minimum: ["openid"]
    self_managed_certificate str
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    self_managed_certificate_nonsensitive str
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    self_managed_expires_on str
    Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.

    Deprecated: Deprecated

    self_managed_private_key str
    RSA private key in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM

    Deprecated: Deprecated

    service_id str
    (Generated) The service id
    token_validity float
    Integer. Access Token Lifetime (in seconds). Default: 1800 (30 minutes), Maximum: 2592000 (30 days)
    validity float
    Integer. Validity of service (in months). Minimum: 1, Maximum: 600 (5 years), Default: 12
    applicationId String
    the application ID (GUID) to attach this service to
    defaultScopes List<String>
    Array. Default scopes. You do not have to specify these explicitly when requesting a token. Minimum: ["openid"]
    description String
    The description of the service
    expiresOn String
    (Generated) Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.
    iamServiceId String
    The GUID of the client
    name String
    The name of the service
    organizationId String
    The organization ID this service belongs to (via application and proposition)
    privateKey String
    (Generated) The active private of the service
    scopes List<String>
    Array. List of supported scopes for this service. Minimum: ["openid"]
    selfManagedCertificate String
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    selfManagedCertificateNonsensitive String
    X509 Certificate in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM. Mutually exclusive with self_managed_private_key
    selfManagedExpiresOn String
    Sets the certificate validity. When not specified, the certificate will have a validity of 5 years.

    Deprecated: Deprecated

    selfManagedPrivateKey String
    RSA private key in PEM format. When provided, overrides the generated certificate / private key combination of the IAM service. This gives you full control over the credentials. When not specified, a private key will be generated by IAM

    Deprecated: Deprecated

    serviceId String
    (Generated) The service id
    tokenValidity Number
    Integer. Access Token Lifetime (in seconds). Default: 1800 (30 minutes), Maximum: 2592000 (30 days)
    validity Number
    Integer. Validity of service (in months). Minimum: 1, Maximum: 600 (5 years), Default: 12

    Import

    Existing services can be imported, however they will be missing their private key rendering them pretty much useless. Therefore, we recommend creating them using the provider.

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

    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