Skip to main content

Get started

Authentication​

To use the Database API, authenticate with Guidewire Hub and obtain an access token.

Before you begin​

If you use the Database 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 Database API and obtained the necessary credentials:

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

Supported scopes​

The Database API supports the following scopes:

ScopeDescription
gcc.deployments.readGet database backup details.
gcc.deployments.writeCreate and delete database backups.
dbservice.snapshots.writeImport a masked snapshot of your production database to a non-production star system.

To perform any operations, the above scopes need to be combined with either the tenant.${TENANT_ID} or any.tenant scope.

Get an access token with supported scopes​

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=tenant.${TENANT_ID} ${SCOPES}" \
    --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. Use one of the following URLs:
RegionURL
AMERhttps://guidewire-hub.okta.com/oauth2/aus11vix3uKEpIfSI357/v1/token
BRAZILhttps://guidewire-hub.okta.com/oauth2/aus11vix3uKEpIfSI357/v1/token
CANADAhttps://guidewire-hub.okta.com/oauth2/aus11vix3uKEpIfSI357/v1/token
EMEAhttps://guidewire-hub-eu.okta.com/oauth2/ausc2q01c40dNZII0416/v1/token
SWITZERLANDhttps://guidewire-hub-eu.okta.com/oauth2/ausc2q01c40dNZII0416/v1/token
APAChttps://guidewire-hub-apac.okta.com/oauth2/ausbg05gfcTZQ7bpH3l6/v1/token
JAPANhttps://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:

{
    "token_type": "Bearer",
    "expires_in": 3600,
    "access_token": "xxxxxxxx",
    "scope": "scope=gcc.deployments.read tenant.${TENANT_ID}"
}
Note:

An access token expires after 60 minutes.

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 "${DATABASE_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:

RegionBase URL
AMERhttps://databaseservice.api.omega2-andromeda.guidewire.net
BRAZILhttps://databaseservice.api.omega2-sculptor.guidewire.net
CANADAhttps://databaseservice.api.omega2-butterfly.guidewire.net
EMEAhttps://databaseservice.api.omega2-cartwheel.guidewire.net
SWITZERLANDhttps://databaseservice.api.omega2-whirlpool.guidewire.net
APAChttps://databaseservice.api.omega2-circinus.guidewire.net
JAPANhttps://databaseservice.api.omega2-milkyway.guidewire.net

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