Get started

Authentication

To use the Runtime Properties API, you must authenticate with Guidewire Hub and obtain an access token with the following scopes:

• gcc.runtimeproperties.write, tenant.{tenantId}
• gcc.runtimeproperties.read, tenant.{tenantId}

Where tenantId is your unique customer name. You need the write scope to use POST and DELETE operations, and the read scope to use GET operations.

Note:

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

Get an access token

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.runtimeproperties.write gcc.runtimeproperties.read tenant.{tenantId}" \
    --data-urlencode "client_id=$GWHUB_CLIENT_ID" \
    --data-urlencode "client_secret=$GWHUB_CLIENT_SECRET"

Depending 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
APAC	https://guidewire-hub-apac.okta.com/oauth2/ausbg05gfcTZQ7bpH3l6/v1/token
JAPAN	https://guidewire-hub-apac.okta.com/oauth2/ausbg05gfcTZQ7bpH3l6/v1/token

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

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

Note:

An access token expires after 60 minutes.

Make an authenticated call

To authenticate API requests, add the obtained access token to an Authorization header:

Authorization: Bearer {access_token}

For example:

curl -s --location --request GET "$RUNTIME_PROPERTIES_API" \
    -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	URL
AMER	https://storageservice.api.omega2-andromeda.guidewire.net
CANADA	https://storageservice.api.omega2-butterfly.guidewire.net
EMEA	https://storageservice.api.omega2-cartwheel.guidewire.net
APAC	https://storageservice.api.omega2-circinus.guidewire.net
JAPAN	https://storageservice.api.omega2-milkyway.guidewire.net

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