Get started

Authentication

To use the InsuranceSuite Deployments API, you need to authenticate with Guidewire Hub and obtain an access token.

Before you begin

If you use the InsuranceSuite Deployments API for the first time:

1. Decide which scopes you need.
2. Register the API in Guidewire Hub. For details on how to register the API, see Access Cloud Platform APIs in the Cloud Platform documentation.

If you already registered the InsuranceSuite Deployments API and obtained the necessary credentials:

1. Get an access token with the supported scopes.
2. Use the generated token to make an authenticated call.

Supported scopes

The InsuranceSuite Deployments API supports the following scopes:

Scope	Description
gcc.projects.read	Allows you to get a list of branches and builds.
gcc.environments.read	Allows you to get information about deployment status for a planet. Must be used with the gcc.deployments.read scope.
gcc.deployments.read	Allows you to get information about deployment status for a planet and get rollback details.
gcc.deployments.write	Allows you to perform deployments, perform rollback, and restore a database backup.

All the above scopes must be combined with the tenant.{tenantId} and project.{projectId} scopes. To check which endpoint require which scopes, refer to the API reference section for each endpoint.

Get an access token

To authenticate with a user access token, you must be in the user group managed by Guidewire Hub. For details, see Access Cloud Platform apps and services.

Send the following request containing your client ID and client secret:

curl -s --location --request POST ${GWHUB_URL} \
    --data-urlencode "grant_type=client_credentials" \
    --data-urlencode "scope=${SCOPES} tenant.${TENANT_ID} project.${PROJECT_ID}" \
    --data-urlencode "client_id=${GWHUB_CLIENT_ID}" \
    --data-urlencode "client_secret=${GWHUB_CLIENT_SECRET}" | jq -r '.access_token'

Where:

• ${GWHUB_URL} depends on your region. Replace ${GWHUB_URL} with one of the following URLs:

  Region	URL
  AMER	https://guidewire-hub.okta.com/oauth2/aus11vix3uKEpIfSI357/v1/token
  BRAZIL	https://guidewire-hub.okta.com/oauth2/aus11vix3uKEpIfSI357/v1/token
  CANADA	https://guidewire-hub.okta.com/oauth2/aus11vix3uKEpIfSI357/v1/token
  EMEA	https://guidewire-hub-eu.okta.com/oauth2/ausc2q01c40dNZII0416/v1/token
  SWITZERLAND	https://guidewire-hub-eu.okta.com/oauth2/ausc2q01c40dNZII0416/v1/token
  APAC	https://guidewire-hub-apac.okta.com/oauth2/ausbg05gfcTZQ7bpH3l6/v1/token
  JAPAN	https://guidewire-hub-apac.okta.com/oauth2/ausbg05gfcTZQ7bpH3l6/v1/token

• ${SCOPES} are the supported scopes. For details on how to get or extend scopes, see Access Cloud Platform APIs.

• ${GWHUB_CLIENT_ID} is a unique identifier for the application that you use to obtain a token from Guidewire Hub. For details on how to get the client ID, see Access Cloud Platform APIs.

• ${GWHUB_CLIENT_SECRET} is a secret for the application that you use to obtain a token from Guidewire Hub. For details on how to get the client secret, see Access Cloud Platform APIs.

The response contains a JSON object with the requested access token. For example:

{
    "token_type": "Bearer",
    "expires_in": 3600,
    "access_token": "xxxxxxxx",
    "scope": "scope=gcc.projects.read gcc.projects.write tenant.${TENANT_ID} project.${PROJECT_ID}"
}

Make an authenticated call

Add the following header with the obtained access token to all your requests:

Authorization: Bearer ${ACCESS_TOKEN}

For example:

curl -s --location --request GET "${GCC_API_URL}" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}"

Base URLs

Depending on your region, use one of the following base URLs:

Region	Base URL
AMER	https://gcc.api.omega2-andromeda.guidewire.net
BRAZIL	https://gcc.api.omega2-sculptor.guidewire.net
CANADA	https://gcc.api.omega2-butterfly.guidewire.net
EMEA	https://gcc.api.omega2-cartwheel.guidewire.net
SWITZERLAND	https://gcc.api.omega2-whirlpool.guidewire.net
APAC	https://gcc.api.omega2-circinus.guidewire.net
JAPAN	https://gcc.api.omega2-milkyway.guidewire.net

When the documentation refers to {baseUrl}, replace it with the correct URL for your region.