Get-BT_Ticket

Syntax

Get-BT_Ticket -Ticket <Ticket> -EndpointUrl <string> [-SetDefault] [-ElevatePrivilege] [-OrganizationId <guid>] [-WorkgroupId <guid>] [<CommonParameters>]

Get-BT_Ticket -Ticket <Ticket> [-Environment <string>] [-SetDefault] [-ElevatePrivilege] [-OrganizationId <guid>] [-WorkgroupId <guid>] [<CommonParameters>]

Get-BT_Ticket -EndpointUrl <string> -Credentials <pscredential> [-ServiceType <ServiceType>] [-SetDefault] [-ElevatePrivilege] [-OrganizationId <guid>] [-WorkgroupId <guid>] [-ImpersonateId <guid>] [<CommonParameters>]

Get-BT_Ticket -Credentials <pscredential> [-Environment <string>] [-ServiceType <ServiceType>] [-SetDefault] [-ElevatePrivilege] [-OrganizationId <guid>] [-WorkgroupId <guid>] [-ImpersonateId <guid>] [<CommonParameters>]

Detailed Description

Get-BT_Ticket gets a(an) BT_Ticket. Represents a BitTitan security ticket, validating the authentication of your BitTitan account. A ticket is always scoped to a BitTitan account and can also be scoped to a ticket organization. A ticket organization is associated with either a workgroup or a customer. A ticket associated with a workgroup will only have access to the customers, end users, services, teams and information belonging to the workgroup while a ticket associated with a customer will only have access to the end users, services and information related to the customer. A ticket without organization id has access to all the workgroups associated with the BitTitan account. Represents a security ticket for BitTitan cmdlets. BitTitan cmdlets contain the BT prefix.

Parameters

Total Parameters: 21

Credentials

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

EndpointUrl

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Ticket

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ElevatePrivilege

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

ImpersonateId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

OrganizationId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ServiceType

Available values are listed below.

Value Description
SmtpLogic SMTP Logic.
Activation Activation.
MigrationWiz MigrationWiz.
BurgerMaster BurgerMaster.
BitTitan BitTitan.
ObsoleteDataEncryption DataEncryption - obsolete; don't use.
Common Common.
CloudArchive CloudArchive - obsolete; don't use.

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SetDefault

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

WorkgroupId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Outputs

System.Object

Notes

Examples

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

$credentials = Get-Credential

$btTicket = Get-BT_Ticket -Credentials $credentials -ServiceType BitTitan

$customers = Get-BT_Customer -Ticket $btTicket -IsDefaultCustomer $true

$customerTicket = Get-BT_Ticket -Ticket $btTicket -OrganizationId $customers[0].OrganizationId

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

$workgroupTicket = Get-BT_Ticket -Ticket $btTicket -OrganizationId $workgroups[0].WorkgroupOrganizationId