1. Packages
  2. Github Provider
  3. API Docs
  4. getCodespacesUserPublicKey
GitHub v6.7.0 published on Friday, Feb 28, 2025 by Pulumi

github.getCodespacesUserPublicKey

Explore with Pulumi AI

Use this data source to retrieve information about a GitHub Codespaces User public key. This data source is required to be used with other GitHub secrets interactions. Note that the provider token must have admin rights to an user to retrieve it’s Codespaces public key.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";

const example = github.getCodespacesUserPublicKey({});
Copy
import pulumi
import pulumi_github as github

example = github.get_codespaces_user_public_key()
Copy
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.GetCodespacesUserPublicKey(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;

return await Deployment.RunAsync(() => 
{
    var example = Github.GetCodespacesUserPublicKey.Invoke();

});
Copy
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 example = GithubFunctions.getCodespacesUserPublicKey();

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: github:getCodespacesUserPublicKey
      arguments: {}
Copy

Using getCodespacesUserPublicKey

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 getCodespacesUserPublicKey(opts?: InvokeOptions): Promise<GetCodespacesUserPublicKeyResult>
function getCodespacesUserPublicKeyOutput(opts?: InvokeOptions): Output<GetCodespacesUserPublicKeyResult>
Copy
def get_codespaces_user_public_key(opts: Optional[InvokeOptions] = None) -> GetCodespacesUserPublicKeyResult
def get_codespaces_user_public_key_output(opts: Optional[InvokeOptions] = None) -> Output[GetCodespacesUserPublicKeyResult]
Copy
func GetCodespacesUserPublicKey(ctx *Context, opts ...InvokeOption) (*GetCodespacesUserPublicKeyResult, error)
func GetCodespacesUserPublicKeyOutput(ctx *Context, opts ...InvokeOption) GetCodespacesUserPublicKeyResultOutput
Copy

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

public static class GetCodespacesUserPublicKey 
{
    public static Task<GetCodespacesUserPublicKeyResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetCodespacesUserPublicKeyResult> Invoke(InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCodespacesUserPublicKeyResult> getCodespacesUserPublicKey(InvokeOptions options)
public static Output<GetCodespacesUserPublicKeyResult> getCodespacesUserPublicKey(InvokeOptions options)
Copy
fn::invoke:
  function: github:index/getCodespacesUserPublicKey:getCodespacesUserPublicKey
  arguments:
    # arguments dictionary
Copy

getCodespacesUserPublicKey Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Key string
Actual key retrieved.
KeyId string
ID of the key that has been retrieved.
Id string
The provider-assigned unique ID for this managed resource.
Key string
Actual key retrieved.
KeyId string
ID of the key that has been retrieved.
id String
The provider-assigned unique ID for this managed resource.
key String
Actual key retrieved.
keyId String
ID of the key that has been retrieved.
id string
The provider-assigned unique ID for this managed resource.
key string
Actual key retrieved.
keyId string
ID of the key that has been retrieved.
id str
The provider-assigned unique ID for this managed resource.
key str
Actual key retrieved.
key_id str
ID of the key that has been retrieved.
id String
The provider-assigned unique ID for this managed resource.
key String
Actual key retrieved.
keyId String
ID of the key that has been retrieved.

Package Details

Repository
GitHub pulumi/pulumi-github
License
Apache-2.0
Notes
This Pulumi package is based on the github Terraform Provider.