Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. cloudidentity
  5. cloudidentity/v1beta1
  6. getMembership

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.cloudidentity/v1beta1.getMembership

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Retrieves a Membership.

    Using getMembership

    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 getMembership(args: GetMembershipArgs, opts?: InvokeOptions): Promise<GetMembershipResult>
function getMembershipOutput(args: GetMembershipOutputArgs, opts?: InvokeOptions): Output<GetMembershipResult>
    def get_membership(group_id: Optional[str] = None,
                   membership_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetMembershipResult
def get_membership_output(group_id: Optional[pulumi.Input[str]] = None,
                   membership_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetMembershipResult]
    func LookupMembership(ctx *Context, args *LookupMembershipArgs, opts ...InvokeOption) (*LookupMembershipResult, error)
func LookupMembershipOutput(ctx *Context, args *LookupMembershipOutputArgs, opts ...InvokeOption) LookupMembershipResultOutput

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

    public static class GetMembership 
{
    public static Task<GetMembershipResult> InvokeAsync(GetMembershipArgs args, InvokeOptions? opts = null)
    public static Output<GetMembershipResult> Invoke(GetMembershipInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMembershipResult> getMembership(GetMembershipArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:cloudidentity/v1beta1:getMembership
  arguments:
    # arguments dictionary

    The following arguments are supported:

    GroupId string
    MembershipId string
    GroupId string
    MembershipId string
    groupId String
    membershipId String
    groupId string
    membershipId string
    groupId String
    membershipId String

    getMembership Result

    The following output properties are available:

    CreateTime string
    The time when the Membership was created.
    DeliverySetting string
    Delivery setting associated with the membership.
    MemberKey Pulumi.GoogleNative.CloudIdentity.V1Beta1.Outputs.EntityKeyResponse
    Immutable. The EntityKey of the member. Either member_key or preferred_member_key must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
    Name string
    The resource name of the Membership. Shall be of the form groups/{group_id}/memberships/{membership_id}.
    PreferredMemberKey Pulumi.GoogleNative.CloudIdentity.V1Beta1.Outputs.EntityKeyResponse
    Immutable. The EntityKey of the member. Either member_key or preferred_member_key must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
    Roles List<Pulumi.GoogleNative.CloudIdentity.V1Beta1.Outputs.MembershipRoleResponse>
    The MembershipRoles that apply to the Membership. If unspecified, defaults to a single MembershipRole with name MEMBER. Must not contain duplicate MembershipRoles with the same name.
    Type string
    The type of the membership.
    UpdateTime string
    The time when the Membership was last updated.
    CreateTime string
    The time when the Membership was created.
    DeliverySetting string
    Delivery setting associated with the membership.
    MemberKey EntityKeyResponse
    Immutable. The EntityKey of the member. Either member_key or preferred_member_key must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
    Name string
    The resource name of the Membership. Shall be of the form groups/{group_id}/memberships/{membership_id}.
    PreferredMemberKey EntityKeyResponse
    Immutable. The EntityKey of the member. Either member_key or preferred_member_key must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
    Roles []MembershipRoleResponse
    The MembershipRoles that apply to the Membership. If unspecified, defaults to a single MembershipRole with name MEMBER. Must not contain duplicate MembershipRoles with the same name.
    Type string
    The type of the membership.
    UpdateTime string
    The time when the Membership was last updated.
    createTime String
    The time when the Membership was created.
    deliverySetting String
    Delivery setting associated with the membership.
    memberKey EntityKeyResponse
    Immutable. The EntityKey of the member. Either member_key or preferred_member_key must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
    name String
    The resource name of the Membership. Shall be of the form groups/{group_id}/memberships/{membership_id}.
    preferredMemberKey EntityKeyResponse
    Immutable. The EntityKey of the member. Either member_key or preferred_member_key must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
    roles List<MembershipRoleResponse>
    The MembershipRoles that apply to the Membership. If unspecified, defaults to a single MembershipRole with name MEMBER. Must not contain duplicate MembershipRoles with the same name.
    type String
    The type of the membership.
    updateTime String
    The time when the Membership was last updated.
    createTime string
    The time when the Membership was created.
    deliverySetting string
    Delivery setting associated with the membership.
    memberKey EntityKeyResponse
    Immutable. The EntityKey of the member. Either member_key or preferred_member_key must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
    name string
    The resource name of the Membership. Shall be of the form groups/{group_id}/memberships/{membership_id}.
    preferredMemberKey EntityKeyResponse
    Immutable. The EntityKey of the member. Either member_key or preferred_member_key must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
    roles MembershipRoleResponse[]
    The MembershipRoles that apply to the Membership. If unspecified, defaults to a single MembershipRole with name MEMBER. Must not contain duplicate MembershipRoles with the same name.
    type string
    The type of the membership.
    updateTime string
    The time when the Membership was last updated.
    create_time str
    The time when the Membership was created.
    delivery_setting str
    Delivery setting associated with the membership.
    member_key EntityKeyResponse
    Immutable. The EntityKey of the member. Either member_key or preferred_member_key must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
    name str
    The resource name of the Membership. Shall be of the form groups/{group_id}/memberships/{membership_id}.
    preferred_member_key EntityKeyResponse
    Immutable. The EntityKey of the member. Either member_key or preferred_member_key must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
    roles Sequence[MembershipRoleResponse]
    The MembershipRoles that apply to the Membership. If unspecified, defaults to a single MembershipRole with name MEMBER. Must not contain duplicate MembershipRoles with the same name.
    type str
    The type of the membership.
    update_time str
    The time when the Membership was last updated.
    createTime String
    The time when the Membership was created.
    deliverySetting String
    Delivery setting associated with the membership.
    memberKey Property Map
    Immutable. The EntityKey of the member. Either member_key or preferred_member_key must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
    name String
    The resource name of the Membership. Shall be of the form groups/{group_id}/memberships/{membership_id}.
    preferredMemberKey Property Map
    Immutable. The EntityKey of the member. Either member_key or preferred_member_key must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned.
    roles List<Property Map>
    The MembershipRoles that apply to the Membership. If unspecified, defaults to a single MembershipRole with name MEMBER. Must not contain duplicate MembershipRoles with the same name.
    type String
    The type of the membership.
    updateTime String
    The time when the Membership was last updated.

    Supporting Types

    EntityKeyResponse

    Namespace string
    The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.
    Namespace string
    The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.
    namespace String
    The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.
    namespace string
    The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.
    namespace str
    The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.
    namespace String
    The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

    ExpiryDetailResponse

    ExpireTime string
    The time at which the MembershipRole will expire.
    ExpireTime string
    The time at which the MembershipRole will expire.
    expireTime String
    The time at which the MembershipRole will expire.
    expireTime string
    The time at which the MembershipRole will expire.
    expire_time str
    The time at which the MembershipRole will expire.
    expireTime String
    The time at which the MembershipRole will expire.

    MembershipRoleResponse

    ExpiryDetail Pulumi.GoogleNative.CloudIdentity.V1Beta1.Inputs.ExpiryDetailResponse
    The expiry details of the MembershipRole. Expiry details are only supported for MEMBER MembershipRoles. May be set if name is MEMBER. Must not be set if name is any other value.
    Name string
    The name of the MembershipRole. Must be one of OWNER, MANAGER, MEMBER.
    RestrictionEvaluations Pulumi.GoogleNative.CloudIdentity.V1Beta1.Inputs.RestrictionEvaluationsResponse
    Evaluations of restrictions applied to parent group on this membership.
    ExpiryDetail ExpiryDetailResponse
    The expiry details of the MembershipRole. Expiry details are only supported for MEMBER MembershipRoles. May be set if name is MEMBER. Must not be set if name is any other value.
    Name string
    The name of the MembershipRole. Must be one of OWNER, MANAGER, MEMBER.
    RestrictionEvaluations RestrictionEvaluationsResponse
    Evaluations of restrictions applied to parent group on this membership.
    expiryDetail ExpiryDetailResponse
    The expiry details of the MembershipRole. Expiry details are only supported for MEMBER MembershipRoles. May be set if name is MEMBER. Must not be set if name is any other value.
    name String
    The name of the MembershipRole. Must be one of OWNER, MANAGER, MEMBER.
    restrictionEvaluations RestrictionEvaluationsResponse
    Evaluations of restrictions applied to parent group on this membership.
    expiryDetail ExpiryDetailResponse
    The expiry details of the MembershipRole. Expiry details are only supported for MEMBER MembershipRoles. May be set if name is MEMBER. Must not be set if name is any other value.
    name string
    The name of the MembershipRole. Must be one of OWNER, MANAGER, MEMBER.
    restrictionEvaluations RestrictionEvaluationsResponse
    Evaluations of restrictions applied to parent group on this membership.
    expiry_detail ExpiryDetailResponse
    The expiry details of the MembershipRole. Expiry details are only supported for MEMBER MembershipRoles. May be set if name is MEMBER. Must not be set if name is any other value.
    name str
    The name of the MembershipRole. Must be one of OWNER, MANAGER, MEMBER.
    restriction_evaluations RestrictionEvaluationsResponse
    Evaluations of restrictions applied to parent group on this membership.
    expiryDetail Property Map
    The expiry details of the MembershipRole. Expiry details are only supported for MEMBER MembershipRoles. May be set if name is MEMBER. Must not be set if name is any other value.
    name String
    The name of the MembershipRole. Must be one of OWNER, MANAGER, MEMBER.
    restrictionEvaluations Property Map
    Evaluations of restrictions applied to parent group on this membership.

    MembershipRoleRestrictionEvaluationResponse

    State string
    The current state of the restriction
    State string
    The current state of the restriction
    state String
    The current state of the restriction
    state string
    The current state of the restriction
    state str
    The current state of the restriction
    state String
    The current state of the restriction

    RestrictionEvaluationsResponse

    MemberRestrictionEvaluation Pulumi.GoogleNative.CloudIdentity.V1Beta1.Inputs.MembershipRoleRestrictionEvaluationResponse
    Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation.
    MemberRestrictionEvaluation MembershipRoleRestrictionEvaluationResponse
    Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation.
    memberRestrictionEvaluation MembershipRoleRestrictionEvaluationResponse
    Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation.
    memberRestrictionEvaluation MembershipRoleRestrictionEvaluationResponse
    Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation.
    member_restriction_evaluation MembershipRoleRestrictionEvaluationResponse
    Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation.
    memberRestrictionEvaluation Property Map
    Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native