pulumi-fusionauth
Version:
A Pulumi package for managing FusionAuth instances.
85 lines (84 loc) • 2.47 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## # User Group Membership Resource
*
* [User Group Membership API](https://fusionauth.io/docs/apis/groups#request-5)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fusionauth from "@pulumi/fusionauth";
*
* const this = fusionauth.getUserGroupMembership({
* groupId: fusionauth_group["this"].id,
* userId: fusionauth_user["this"].id,
* });
* ```
*/
export declare function getUserGroupMembership(args: GetUserGroupMembershipArgs, opts?: pulumi.InvokeOptions): Promise<GetUserGroupMembershipResult>;
/**
* A collection of arguments for invoking getUserGroupMembership.
*/
export interface GetUserGroupMembershipArgs {
/**
* The Id of the Group of this membership.
*/
groupId: string;
/**
* "The Id of the User of this membership.
*/
userId: string;
}
/**
* A collection of values returned by getUserGroupMembership.
*/
export interface GetUserGroupMembershipResult {
/**
* (Optional) An object that can hold any information about the User for this membership that should be persisted.
*/
readonly data: {
[key: string]: string;
};
readonly groupId: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* (Optional) The Id of the User Group Membership. If not provided, a random UUID will be generated.
*/
readonly membershipId: string;
readonly userId: string;
}
/**
* ## # User Group Membership Resource
*
* [User Group Membership API](https://fusionauth.io/docs/apis/groups#request-5)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fusionauth from "@pulumi/fusionauth";
*
* const this = fusionauth.getUserGroupMembership({
* groupId: fusionauth_group["this"].id,
* userId: fusionauth_user["this"].id,
* });
* ```
*/
export declare function getUserGroupMembershipOutput(args: GetUserGroupMembershipOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetUserGroupMembershipResult>;
/**
* A collection of arguments for invoking getUserGroupMembership.
*/
export interface GetUserGroupMembershipOutputArgs {
/**
* The Id of the Group of this membership.
*/
groupId: pulumi.Input<string>;
/**
* "The Id of the User of this membership.
*/
userId: pulumi.Input<string>;
}