Get started

Authentication

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

Before you begin

If you use the Runtime Properties 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 Runtime Properties 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 Runtime Properties API supports the following scopes:

• gcc.runtimeproperties.write, tenant.${TENANT_ID}
• gcc.runtimeproperties.read, tenant.${TENANT_ID}

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

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=${SCOPES} tenant.${TENANT_ID}" \
    --data-urlencode "client_id=${GWHUB_CLIENT_ID}" \
    --data-urlencode "client_secret=${GWHUB_CLIENT_SECRET}"

Where:

• ${GWHUB_URL} depends on your region. Use 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.runtimeproperties.write gcc.runtimeproperties.read tenant.${TENANT_ID}"
}

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
BRAZIL	https://storageservice.api.omega2-sculptor.guidewire.net
CANADA	https://storageservice.api.omega2-butterfly.guidewire.net
EMEA	https://storageservice.api.omega2-cartwheel.guidewire.net
SWITZERLAND	https://storageservice.api.omega2-whirlpool.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.