Get started

Authentication

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

Note:

To get credentials, submit a case to create a Guidewire Hub application using the Register Deployments API Application (GWHUB-0100) template.

For all the planet classes, to perform any operations, you must have an access token with tenant.{tenantId} and project.{projectId} scopes. Each endpoint might require additional scopes. You can find all the additional scopes in the endpoint descriptions, in the API reference section.

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=gcc.projects.read gcc.projects.write
                        tenant.{tenantId} project.{projectId}" \
    --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
  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

• GWHUB_CLIENT_SECRET is an environment variable with your credentials.

  To get credentials, submit a case to create a Guidewire Hub application using the Register Deployments API Application (GWHUB-0100) template.

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

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

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
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.