1. Packages
  2. Nexus Provider
  3. API Docs
  4. getSecuritySaml
nexus 2.5.0 published on Monday, Apr 14, 2025 by datadrivers

nexus.getSecuritySaml

Explore with Pulumi AI

nexus logo
nexus 2.5.0 published on Monday, Apr 14, 2025 by datadrivers

    PRO Feature

    Use this data source to get the saml configuration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nexus from "@pulumi/nexus";
    
    const saml = nexus.getSecuritySaml({});
    export const samlEntityId = saml.then(saml => saml.entityId);
    
    import pulumi
    import pulumi_nexus as nexus
    
    saml = nexus.get_security_saml()
    pulumi.export("samlEntityId", saml.entity_id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/nexus/v2/nexus"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		saml, err := nexus.LookupSecuritySaml(ctx, map[string]interface{}{}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("samlEntityId", saml.EntityId)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nexus = Pulumi.Nexus;
    
    return await Deployment.RunAsync(() => 
    {
        var saml = Nexus.GetSecuritySaml.Invoke();
    
        return new Dictionary<string, object?>
        {
            ["samlEntityId"] = saml.Apply(getSecuritySamlResult => getSecuritySamlResult.EntityId),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nexus.NexusFunctions;
    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 saml = NexusFunctions.getSecuritySaml();
    
            ctx.export("samlEntityId", saml.applyValue(getSecuritySamlResult -> getSecuritySamlResult.entityId()));
        }
    }
    
    variables:
      saml:
        fn::invoke:
          function: nexus:getSecuritySaml
          arguments: {}
    outputs:
      samlEntityId: ${saml.entityId}
    

    Using getSecuritySaml

    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 getSecuritySaml(opts?: InvokeOptions): Promise<GetSecuritySamlResult>
    function getSecuritySamlOutput(opts?: InvokeOptions): Output<GetSecuritySamlResult>
    def get_security_saml(opts: Optional[InvokeOptions] = None) -> GetSecuritySamlResult
    def get_security_saml_output(opts: Optional[InvokeOptions] = None) -> Output[GetSecuritySamlResult]
    func LookupSecuritySaml(ctx *Context, opts ...InvokeOption) (*LookupSecuritySamlResult, error)
    func LookupSecuritySamlOutput(ctx *Context, opts ...InvokeOption) LookupSecuritySamlResultOutput

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

    public static class GetSecuritySaml 
    {
        public static Task<GetSecuritySamlResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetSecuritySamlResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSecuritySamlResult> getSecuritySaml(InvokeOptions options)
    public static Output<GetSecuritySamlResult> getSecuritySaml(InvokeOptions options)
    
    fn::invoke:
      function: nexus:index/getSecuritySaml:getSecuritySaml
      arguments:
        # arguments dictionary

    getSecuritySaml Result

    The following output properties are available:

    EmailAttribute string
    IdP field mappings for user's email address
    EntityId string
    Entity ID URI
    FirstNameAttribute string
    IdP field mappings for user's given name
    GroupsAttribute string
    IdP field mappings for user's groups
    Id string
    Used to identify data source at nexus
    IdpMetadata string
    SAML Identity Provider Metadata XML
    LastNameAttribute string
    IdP field mappings for user's family name
    UsernameAttribute string
    IdP field mappings for username
    ValidateAssertionSignature bool
    By default, if a signing key is found in the IdP metadata, then NXRM will attempt to validate signatures on the assertions.
    ValidateResponseSignature bool
    By default, if a signing key is found in the IdP metadata, then NXRM will attempt to validate signatures on the response.
    EmailAttribute string
    IdP field mappings for user's email address
    EntityId string
    Entity ID URI
    FirstNameAttribute string
    IdP field mappings for user's given name
    GroupsAttribute string
    IdP field mappings for user's groups
    Id string
    Used to identify data source at nexus
    IdpMetadata string
    SAML Identity Provider Metadata XML
    LastNameAttribute string
    IdP field mappings for user's family name
    UsernameAttribute string
    IdP field mappings for username
    ValidateAssertionSignature bool
    By default, if a signing key is found in the IdP metadata, then NXRM will attempt to validate signatures on the assertions.
    ValidateResponseSignature bool
    By default, if a signing key is found in the IdP metadata, then NXRM will attempt to validate signatures on the response.
    emailAttribute String
    IdP field mappings for user's email address
    entityId String
    Entity ID URI
    firstNameAttribute String
    IdP field mappings for user's given name
    groupsAttribute String
    IdP field mappings for user's groups
    id String
    Used to identify data source at nexus
    idpMetadata String
    SAML Identity Provider Metadata XML
    lastNameAttribute String
    IdP field mappings for user's family name
    usernameAttribute String
    IdP field mappings for username
    validateAssertionSignature Boolean
    By default, if a signing key is found in the IdP metadata, then NXRM will attempt to validate signatures on the assertions.
    validateResponseSignature Boolean
    By default, if a signing key is found in the IdP metadata, then NXRM will attempt to validate signatures on the response.
    emailAttribute string
    IdP field mappings for user's email address
    entityId string
    Entity ID URI
    firstNameAttribute string
    IdP field mappings for user's given name
    groupsAttribute string
    IdP field mappings for user's groups
    id string
    Used to identify data source at nexus
    idpMetadata string
    SAML Identity Provider Metadata XML
    lastNameAttribute string
    IdP field mappings for user's family name
    usernameAttribute string
    IdP field mappings for username
    validateAssertionSignature boolean
    By default, if a signing key is found in the IdP metadata, then NXRM will attempt to validate signatures on the assertions.
    validateResponseSignature boolean
    By default, if a signing key is found in the IdP metadata, then NXRM will attempt to validate signatures on the response.
    email_attribute str
    IdP field mappings for user's email address
    entity_id str
    Entity ID URI
    first_name_attribute str
    IdP field mappings for user's given name
    groups_attribute str
    IdP field mappings for user's groups
    id str
    Used to identify data source at nexus
    idp_metadata str
    SAML Identity Provider Metadata XML
    last_name_attribute str
    IdP field mappings for user's family name
    username_attribute str
    IdP field mappings for username
    validate_assertion_signature bool
    By default, if a signing key is found in the IdP metadata, then NXRM will attempt to validate signatures on the assertions.
    validate_response_signature bool
    By default, if a signing key is found in the IdP metadata, then NXRM will attempt to validate signatures on the response.
    emailAttribute String
    IdP field mappings for user's email address
    entityId String
    Entity ID URI
    firstNameAttribute String
    IdP field mappings for user's given name
    groupsAttribute String
    IdP field mappings for user's groups
    id String
    Used to identify data source at nexus
    idpMetadata String
    SAML Identity Provider Metadata XML
    lastNameAttribute String
    IdP field mappings for user's family name
    usernameAttribute String
    IdP field mappings for username
    validateAssertionSignature Boolean
    By default, if a signing key is found in the IdP metadata, then NXRM will attempt to validate signatures on the assertions.
    validateResponseSignature Boolean
    By default, if a signing key is found in the IdP metadata, then NXRM will attempt to validate signatures on the response.

    Package Details

    Repository
    nexus datadrivers/terraform-provider-nexus
    License
    Notes
    This Pulumi package is based on the nexus Terraform Provider.
    nexus logo
    nexus 2.5.0 published on Monday, Apr 14, 2025 by datadrivers