1. Packages
  2. GitHub
  3. API Docs
  4. getOrganizationExternalIdentities
GitHub v6.2.2 published on Tuesday, Jun 18, 2024 by Pulumi

github.getOrganizationExternalIdentities

Explore with Pulumi AI

github logo
GitHub v6.2.2 published on Tuesday, Jun 18, 2024 by Pulumi

    Use this data source to retrieve each organization member’s SAML or SCIM user attributes.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as github from "@pulumi/github";
    
    const all = github.getOrganizationExternalIdentities({});
    
    import pulumi
    import pulumi_github as github
    
    all = github.get_organization_external_identities()
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-github/sdk/v6/go/github"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := github.GetOrganizationExternalIdentities(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Github = Pulumi.Github;
    
    return await Deployment.RunAsync(() => 
    {
        var all = Github.GetOrganizationExternalIdentities.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.github.GithubFunctions;
    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 all = GithubFunctions.getOrganizationExternalIdentities();
    
        }
    }
    
    variables:
      all:
        fn::invoke:
          Function: github:getOrganizationExternalIdentities
          Arguments: {}
    

    Using getOrganizationExternalIdentities

    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 getOrganizationExternalIdentities(opts?: InvokeOptions): Promise<GetOrganizationExternalIdentitiesResult>
    function getOrganizationExternalIdentitiesOutput(opts?: InvokeOptions): Output<GetOrganizationExternalIdentitiesResult>
    def get_organization_external_identities(opts: Optional[InvokeOptions] = None) -> GetOrganizationExternalIdentitiesResult
    def get_organization_external_identities_output(opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationExternalIdentitiesResult]
    func GetOrganizationExternalIdentities(ctx *Context, opts ...InvokeOption) (*GetOrganizationExternalIdentitiesResult, error)
    func GetOrganizationExternalIdentitiesOutput(ctx *Context, opts ...InvokeOption) GetOrganizationExternalIdentitiesResultOutput

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

    public static class GetOrganizationExternalIdentities 
    {
        public static Task<GetOrganizationExternalIdentitiesResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetOrganizationExternalIdentitiesResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOrganizationExternalIdentitiesResult> getOrganizationExternalIdentities(InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: github:index/getOrganizationExternalIdentities:getOrganizationExternalIdentities
      arguments:
        # arguments dictionary

    getOrganizationExternalIdentities Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Identities List<GetOrganizationExternalIdentitiesIdentity>
    An Array of identities returned from GitHub
    Id string
    The provider-assigned unique ID for this managed resource.
    Identities []GetOrganizationExternalIdentitiesIdentity
    An Array of identities returned from GitHub
    id String
    The provider-assigned unique ID for this managed resource.
    identities List<GetOrganizationExternalIdentitiesIdentity>
    An Array of identities returned from GitHub
    id string
    The provider-assigned unique ID for this managed resource.
    identities GetOrganizationExternalIdentitiesIdentity[]
    An Array of identities returned from GitHub
    id str
    The provider-assigned unique ID for this managed resource.
    identities Sequence[GetOrganizationExternalIdentitiesIdentity]
    An Array of identities returned from GitHub
    id String
    The provider-assigned unique ID for this managed resource.
    identities List<Property Map>
    An Array of identities returned from GitHub

    Supporting Types

    GetOrganizationExternalIdentitiesIdentity

    Login string
    The username of the GitHub user
    SamlIdentity Dictionary<string, string>
    An Object containing the user's SAML data. This object will be empty if the user is not managed by SAML.
    ScimIdentity Dictionary<string, string>
    An Object contining the user's SCIM data. This object will be empty if the user is not managed by SCIM.
    Login string
    The username of the GitHub user
    SamlIdentity map[string]string
    An Object containing the user's SAML data. This object will be empty if the user is not managed by SAML.
    ScimIdentity map[string]string
    An Object contining the user's SCIM data. This object will be empty if the user is not managed by SCIM.
    login String
    The username of the GitHub user
    samlIdentity Map<String,String>
    An Object containing the user's SAML data. This object will be empty if the user is not managed by SAML.
    scimIdentity Map<String,String>
    An Object contining the user's SCIM data. This object will be empty if the user is not managed by SCIM.
    login string
    The username of the GitHub user
    samlIdentity {[key: string]: string}
    An Object containing the user's SAML data. This object will be empty if the user is not managed by SAML.
    scimIdentity {[key: string]: string}
    An Object contining the user's SCIM data. This object will be empty if the user is not managed by SCIM.
    login str
    The username of the GitHub user
    saml_identity Mapping[str, str]
    An Object containing the user's SAML data. This object will be empty if the user is not managed by SAML.
    scim_identity Mapping[str, str]
    An Object contining the user's SCIM data. This object will be empty if the user is not managed by SCIM.
    login String
    The username of the GitHub user
    samlIdentity Map<String>
    An Object containing the user's SAML data. This object will be empty if the user is not managed by SAML.
    scimIdentity Map<String>
    An Object contining the user's SCIM data. This object will be empty if the user is not managed by SCIM.

    Package Details

    Repository
    GitHub pulumi/pulumi-github
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the github Terraform Provider.
    github logo
    GitHub v6.2.2 published on Tuesday, Jun 18, 2024 by Pulumi