Skip to main content

Get started

Authentication

To use the Database API, authenticate with Guidewire Hub and obtain an access token. To perform any operations, you must have an access token with tenant.{tenantId} or any.tenant scopes.

note

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

Get an access token

To get a user access token, you must be in the {tenant}.dev.{project}.all.gcc.developers user group.

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.deployments.read gcc.deployments.write tenant.{tenantId}" \
--data-urlencode "client_id=$OKTA_CLIENT_ID" \
--data-urlencode "client_secret=$OKTA_CLIENT_SECRET" | jq -r '.access_token'

Depending on your region, replace GWHUB_URL with one of the following URLs:

RegionURL
AMERhttps://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
APAChttps://guidewire-hub-apac.okta.com/oauth2/ausbg05gfcTZQ7bpH3l6/v1/token
JAPANhttps://guidewire-hub-apac.okta.com/oauth2/ausbg05gfcTZQ7bpH3l6/v1/token

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

{
"token_type": "Bearer",
"expires_in": 3600,
"access_token": "xxxxxxxx",
"scope": "scope=gcc.deployments.read
tenant.{tenantId}"
}
info

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/
CANADAhttps://databaseservice.api.omega2-butterfly.guidewire.net/
EMEAhttps://databaseservice.api.omega2-cartwheel.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.

Legal and support information

Published: December 3, 2024 at 9:49 AM

© 2024 Guidewire Software, Inc.