Get-BT_OrganizationMember

Syntax

Get-BT_OrganizationMember -Ticket <Ticket> [-Environment <string>] [-PageOffset <int>] [-PageSize <int>] [-RetrieveAll] [-ShouldUnmaskProperties <bool>] [-Id <Object[]>] [-IsDeleted <string>] [-Created <string[]>] [-SortBy_Created_Ascending] [-SortBy_Created_Descending] [-Updated <string[]>] [-SortBy_Updated_Ascending] [-SortBy_Updated_Descending] [-Version <Object[]>] [-SortBy_Version_Ascending] [-SortBy_Version_Descending] [-OrganizationId <Object[]>] [-SystemUserId <Object[]>] [-InvitingSystemUserId <Object[]>] [-UserRoles <string[]>] [-WorkgroupCreated <string[]>] [-WorkgroupUpdated <string[]>] [-WorkgroupCreatedBySystemUserId <Object[]>] [-WorkgroupWorkgroupOrganizationId <Object[]>] [-WorkgroupName <Object[]>] [-WorkgroupDefaultPaymentProfileId <Object[]>] [-WorkgroupHasHadPaymentProfile <string>] [-WorkgroupExchangeRateId <Object[]>] [-WorkgroupCouponReedemingStatus <string[]>] [-WorkgroupHasOptOutDistributorSuggestion <string>] [-WorkgroupNetTermsPaymentDays <Object[]>] [-WorkgroupPlanType <string[]>] [-WorkgroupSkipChargesUntil <string[]>] [-WorkgroupBillingStatus <string[]>] [-WorkgroupTrialPlanType <string[]>] [-WorkgroupTrialPlanEndDate <string[]>] [-WorkgroupBillingGracePeriodEndDate <string[]>] [-WorkgroupCustomerCreated <string[]>] [-WorkgroupCustomerUpdated <string[]>] [-WorkgroupCustomerSystemUserId <Object[]>] [-WorkgroupCustomerOrganizationId <Object[]>] [-WorkgroupCustomerPrimaryDomain <Object[]>] [-WorkgroupCustomerCompanyName <Object[]>] [-WorkgroupCustomerCountryName <Object[]>] [-WorkgroupCustomerStateProvinceName <Object[]>] [-WorkgroupCustomerCityName <Object[]>] [-WorkgroupCustomerIndustryType <string[]>] [-WorkgroupCustomerCompanySizeBucket <string[]>] [-WorkgroupCustomerShortId <Object[]>] [-WorkgroupCustomerIsArchived <string>] [-WorkgroupCustomerCustomerSubscriptionRenewalPolicy <string[]>] [-WorkgroupCustomerLastAccessed <string[]>] [-WorkgroupCustomerIsDefaultCustomer <string>] [-WorkgroupCustomerIsDemoCustomer <string>] [-WorkgroupCustomerWorkgroupId <Object[]>] [-WorkgroupCustomerProjectStatsCreated <string[]>] [-WorkgroupCustomerProjectStatsUpdated <string[]>] [-WorkgroupCustomerProjectStatsSystemUserId <Object[]>] [-WorkgroupCustomerProjectStatsOrganizationId <Object[]>] [-WorkgroupCustomerProjectStatsName <Object[]>] [-WorkgroupCustomerProjectStatsStatus <string[]>] [-WorkgroupCustomerProjectStatsApplicationServiceId <Object[]>] [-WorkgroupCustomerProjectStatsIsNotGenerated <string>] [-WorkgroupCustomerProjectStatsApplicationServiceType <string[]>] [-WorkgroupCustomerProjectStatsExternalProjectId <Object[]>] [-WorkgroupCustomerProjectStatsOfferingInstanceId <Object[]>] [-WorkgroupCustomerExtendedPropertyCreated <string[]>] [-WorkgroupCustomerExtendedPropertyUpdated <string[]>] [-WorkgroupCustomerExtendedPropertySystemUserId <Object[]>] [-WorkgroupCustomerExtendedPropertyReferenceEntityType <Object[]>] [-WorkgroupCustomerExtendedPropertyReferenceEntityId <Object[]>] [-WorkgroupCustomerExtendedPropertyName <Object[]>] [-WorkgroupCustomerExtendedPropertyIsEncrypted <string>] [-WorkgroupCustomerExtendedPropertyWorkgroupOrganizationId <Object[]>] [<CommonParameters>]

Get-BT_OrganizationMember -Ticket <Ticket> -EndpointUrl <string> [-PageOffset <int>] [-PageSize <int>] [-RetrieveAll] [-ShouldUnmaskProperties <bool>] [-Id <Object[]>] [-IsDeleted <string>] [-Created <string[]>] [-SortBy_Created_Ascending] [-SortBy_Created_Descending] [-Updated <string[]>] [-SortBy_Updated_Ascending] [-SortBy_Updated_Descending] [-Version <Object[]>] [-SortBy_Version_Ascending] [-SortBy_Version_Descending] [-OrganizationId <Object[]>] [-SystemUserId <Object[]>] [-InvitingSystemUserId <Object[]>] [-UserRoles <string[]>] [-WorkgroupCreated <string[]>] [-WorkgroupUpdated <string[]>] [-WorkgroupCreatedBySystemUserId <Object[]>] [-WorkgroupWorkgroupOrganizationId <Object[]>] [-WorkgroupName <Object[]>] [-WorkgroupDefaultPaymentProfileId <Object[]>] [-WorkgroupHasHadPaymentProfile <string>] [-WorkgroupExchangeRateId <Object[]>] [-WorkgroupCouponReedemingStatus <string[]>] [-WorkgroupHasOptOutDistributorSuggestion <string>] [-WorkgroupNetTermsPaymentDays <Object[]>] [-WorkgroupPlanType <string[]>] [-WorkgroupSkipChargesUntil <string[]>] [-WorkgroupBillingStatus <string[]>] [-WorkgroupTrialPlanType <string[]>] [-WorkgroupTrialPlanEndDate <string[]>] [-WorkgroupBillingGracePeriodEndDate <string[]>] [-WorkgroupCustomerCreated <string[]>] [-WorkgroupCustomerUpdated <string[]>] [-WorkgroupCustomerSystemUserId <Object[]>] [-WorkgroupCustomerOrganizationId <Object[]>] [-WorkgroupCustomerPrimaryDomain <Object[]>] [-WorkgroupCustomerCompanyName <Object[]>] [-WorkgroupCustomerCountryName <Object[]>] [-WorkgroupCustomerStateProvinceName <Object[]>] [-WorkgroupCustomerCityName <Object[]>] [-WorkgroupCustomerIndustryType <string[]>] [-WorkgroupCustomerCompanySizeBucket <string[]>] [-WorkgroupCustomerShortId <Object[]>] [-WorkgroupCustomerIsArchived <string>] [-WorkgroupCustomerCustomerSubscriptionRenewalPolicy <string[]>] [-WorkgroupCustomerLastAccessed <string[]>] [-WorkgroupCustomerIsDefaultCustomer <string>] [-WorkgroupCustomerIsDemoCustomer <string>] [-WorkgroupCustomerWorkgroupId <Object[]>] [-WorkgroupCustomerProjectStatsCreated <string[]>] [-WorkgroupCustomerProjectStatsUpdated <string[]>] [-WorkgroupCustomerProjectStatsSystemUserId <Object[]>] [-WorkgroupCustomerProjectStatsOrganizationId <Object[]>] [-WorkgroupCustomerProjectStatsName <Object[]>] [-WorkgroupCustomerProjectStatsStatus <string[]>] [-WorkgroupCustomerProjectStatsApplicationServiceId <Object[]>] [-WorkgroupCustomerProjectStatsIsNotGenerated <string>] [-WorkgroupCustomerProjectStatsApplicationServiceType <string[]>] [-WorkgroupCustomerProjectStatsExternalProjectId <Object[]>] [-WorkgroupCustomerProjectStatsOfferingInstanceId <Object[]>] [-WorkgroupCustomerExtendedPropertyCreated <string[]>] [-WorkgroupCustomerExtendedPropertyUpdated <string[]>] [-WorkgroupCustomerExtendedPropertySystemUserId <Object[]>] [-WorkgroupCustomerExtendedPropertyReferenceEntityType <Object[]>] [-WorkgroupCustomerExtendedPropertyReferenceEntityId <Object[]>] [-WorkgroupCustomerExtendedPropertyName <Object[]>] [-WorkgroupCustomerExtendedPropertyIsEncrypted <string>] [-WorkgroupCustomerExtendedPropertyWorkgroupOrganizationId <Object[]>] [<CommonParameters>]

Detailed Description

Get-BT_OrganizationMember gets a(an) BT_OrganizationMember. Represents an organization member. An organization member represents the association between a BitTitan account (system user) and an organization. An organization represents a scope for a BitTitan ticket, which can be associated with either a customer or a workgroup.

Parameters

Total Parameters: 87

EndpointUrl

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Ticket

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Created

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Environment

Available values are listed below.

Value Description
BT Represents BT
Beta Represents Beta
Develop Represents Develop
Release Represents Release
Test Represents Test
China Represents China
Germany Represents Germany
Alpha Represents Alpha
Today Represents Today
Sandbox-02 Represents Sandbox-02
Sandbox-03 Represents Sandbox-03

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Id

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

InvitingSystemUserId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

IsDeleted

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

OrganizationId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

PageOffset

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

PageSize

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

RetrieveAll

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ShouldUnmaskProperties

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Created_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Created_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Updated_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Updated_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Version_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Version_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SystemUserId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Updated

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

UserRoles

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Version

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Outputs

System.Object

Notes

Organization type

The two main organization types are Production and Workgroup.

Production means that the organization is associated with a customer while Workgroup means that the organization is associated with a workgroup.

Both customers and workgroups can be associated with multiple BitTitan accounts (system users).


User roles

BitTitan accounts (system users) have a user roles in each organization they belong to. The available user roles are admin, manager and agent. For more details about user roles, please check our online MSPComplete knowledge base.


Examples

-------------------------- Example 1 -------------------------

$workgroups = Get-BT_Workgroup -Ticket $btTicket -Name "isnull"

$organizationMembers = Get-BT_OrganizationMember -Ticket $btTicket -OrganizationId $workgroups[0].WorkgroupOrganizationId