Skip to main content

Get Environment Xbox Config

GET 
/v1/environment/:environment_id/xbox

Get the Xbox configuration for a specific environment

Request​

Path Parameters

    environment_id uuidrequired

    The environment ID for this request

Responses​

Successful Response

Schema

    business_partner_cert Business Partner Cert (string)

    Business Partner Certificate used to generate service tokens. This is required to process Xbox platform entitlements. NOTE - these expire every 18 months.

    relying_parties

    object[]

    Relying Parties for validating XSTS tokens. This is required for authenticating users. NOTE - the first relying party is used as

  • Array [

    • uri Uri (string)required

    Possible values: <= 128 characters

    Relying Party URI

    cert Cert (string)required

    Relying Party Certificate

  • ]

    • default_sandbox Default Sandbox (string)

    Possible values: <= 128 characters

    Default value: RETAIL

    Default Sandbox used when one is not provided in a user token or as part of an operation in the environment.

    entra_tenant_id Entra Tenant Id (string)

    Possible values: <= 128 characters

    Application Tenant ID (Directory ID) of the Azure Registered App - https://portal.azure.com/#view/Microsoft_AAD_RegisteredApps/ApplicationsListBlade

    entra_client_id Entra Client Id (string)

    Possible values: <= 128 characters

    Application Client ID (Application ID) of the Azure Registered App - https://portal.azure.com/#view/Microsoft_AAD_RegisteredApps/ApplicationsListBlade

    entra_client_secret Entra Client Secret (string)

    Possible values: <= 128 characters

    Client Secret of the Azure Registered App

Loading...