@pulumi/github
Version:
A Pulumi package for creating and managing github cloud resources.
83 lines (82 loc) • 2.34 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Use this data source to retrieve a specific organization member's SAML or SCIM user
* attributes.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as github from "@pulumi/github";
*
* const exampleUser = github.getUserExternalIdentity({
* username: "example-user",
* });
* ```
*/
export declare function getUserExternalIdentity(args: GetUserExternalIdentityArgs, opts?: pulumi.InvokeOptions): Promise<GetUserExternalIdentityResult>;
/**
* A collection of arguments for invoking getUserExternalIdentity.
*/
export interface GetUserExternalIdentityArgs {
/**
* The username of the member to fetch external identity for.
*/
username: string;
}
/**
* A collection of values returned by getUserExternalIdentity.
*/
export interface GetUserExternalIdentityResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The username of the GitHub user
*/
readonly login: string;
/**
* An Object containing the user's SAML data. This object will
* be empty if the user is not managed by SAML.
*/
readonly samlIdentity: {
[key: string]: string;
};
/**
* An Object contining the user's SCIM data. This object will
* be empty if the user is not managed by SCIM.
*/
readonly scimIdentity: {
[key: string]: string;
};
/**
* The member's SAML Username
*/
readonly username: string;
}
/**
* Use this data source to retrieve a specific organization member's SAML or SCIM user
* attributes.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as github from "@pulumi/github";
*
* const exampleUser = github.getUserExternalIdentity({
* username: "example-user",
* });
* ```
*/
export declare function getUserExternalIdentityOutput(args: GetUserExternalIdentityOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetUserExternalIdentityResult>;
/**
* A collection of arguments for invoking getUserExternalIdentity.
*/
export interface GetUserExternalIdentityOutputArgs {
/**
* The username of the member to fetch external identity for.
*/
username: pulumi.Input<string>;
}