{ "openapi" : "3.0.1", "info" : { "description" : "

\n All requests require authentication. Press the Authorize button below, select the groups\n and tenant_id scopes, then press Authorize. There is no need to change the client_id\n field. You will be redirected to this page upon successful authentication with Okta.\n

", "title" : "Settings Vault (Helios)", "version" : "1" }, "servers" : [ { "url" : "/api" } ], "security" : [ { "Guidewire-Hub" : [ "groups", "tenant_id" ] } ], "tags" : [ { "name" : "springClient" }, { "name" : "client" }, { "name" : "applications" }, { "name" : "setting-values v2" }, { "name" : "setting-values" }, { "name" : "whoami" }, { "name" : "beta" }, { "name" : "tenants" }, { "name" : "rolemappings" }, { "description" : "[FOR FUTURE USE (NOT IMPLEMENTED / AVAILABLE)]", "name" : "secret-rotations" } ], "paths" : { "/v1/whoami" : { "get" : { "operationId" : "getCurrentUserInfo", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "can be used to test pulling the tenant from the query parameter", "explode" : true, "in" : "query", "name" : "testDeploymentId", "required" : false, "schema" : { "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserSecurityInfo" } } }, "description" : "Successful operation" }, "401" : { "description" : "Unauthorized" } }, "summary" : "Details about the current user", "tags" : [ "whoami" ] } }, "/v1/tenants" : { "get" : { "description" : "Provides a way to search for tenants. If no criteria is specified, all tenants are listed.

Security - caller must have admin-global role.", "operationId" : "getAllTenants", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "deprecated" : true, "description" : "0 based, value of the page being viewed", "explode" : true, "in" : "query", "name" : "page", "required" : false, "schema" : { "default" : 0, "type" : "integer" }, "style" : "form" }, { "description" : "1 based, number of elements to be viewed per page. Default is 100.", "explode" : true, "in" : "query", "name" : "pageSize", "required" : false, "schema" : { "default" : 100, "type" : "integer" }, "style" : "form" }, { "description" : "token to query next page results ", "explode" : true, "in" : "query", "name" : "nextPageToken", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "The name of the tenant you are searching for. Supports partial, case-insensitive matching", "explode" : true, "in" : "query", "name" : "name", "required" : false, "schema" : { "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/Tenant" }, "type" : "array" } } }, "description" : "Successful operation", "headers" : { "x-gwre-next-page-token" : { "description" : "The token to query next set of results, will only appear if there is a next page of results.", "explode" : false, "schema" : { "type" : "string" }, "style" : "simple" } } }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" } }, "summary" : "Get all tenants", "tags" : [ "tenants" ] }, "post" : { "description" : "Create a tenant

Security - caller must have admin-global role.", "operationId" : "createTenant", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/Tenant" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tenant" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Create a tenant", "tags" : [ "tenants" ] } }, "/v1/tenants/{tenantId}" : { "delete" : { "description" : "Deletes a tenant.

Security - caller must have admin-global role.", "operationId" : "deleteTenant", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the tenant (surrogate key)", "explode" : false, "in" : "path", "name" : "tenantId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "responses" : { "204" : { "description" : "Successful operation" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" } }, "summary" : "Delete a tenant", "tags" : [ "tenants" ] }, "get" : { "description" : "Retrieve information about a tenant.

Security - caller must have admin-global role.", "operationId" : "getTenant", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the tenant (surrogate key)", "explode" : false, "in" : "path", "name" : "tenantId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tenant" } } }, "description" : "Successful operation" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" } }, "summary" : "Get a tenant", "tags" : [ "tenants" ] }, "put" : { "description" : "Provides a way to update an existing tenant.

Version is required in order to prevent concurrent updates

Security - Security - caller must have admin-global role.", "operationId" : "updateTenant", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the tenant (surrogate key)", "explode" : false, "in" : "path", "name" : "tenantId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/Tenant" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tenant" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Update tenant.", "tags" : [ "tenants" ] } }, "/v1/setting-values" : { "get" : { "description" : "Provides a way to search for setting values. If no criteria is specified, all setting values are listed.

Security - caller must have {appname}.read role.", "operationId" : "getAllSettingValues", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "1 based, number of elements to be viewed per page. Default is 100.", "explode" : true, "in" : "query", "name" : "pageSize", "required" : false, "schema" : { "default" : 100, "type" : "integer" }, "style" : "form" }, { "description" : "token to query next page results ", "explode" : true, "in" : "query", "name" : "nextPageToken", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Name of the application whose setting values you are searching for.\nSupports partial, case-insensitive matching.\n\n**Tip:**\nIt's strongly recommended that one always include an `application` name in their search for best performance.\n", "explode" : true, "in" : "query", "name" : "application", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Name (case-insensitive) of the **Planet-Class / Orbit** whose setting values you are searching for.\n\n**This attribute is only used when `layer-type` is set to `environment_level` or `project_planet_class`.**\n", "explode" : true, "in" : "query", "name" : "environment", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Name (case-insensitive) of the **Insurer Project / Star** whose setting values you are searching for.\n\n**This attribute is only used when `layer-type` is set to `insurer_project` or `project_planet_class`.**\n", "explode" : true, "in" : "query", "name" : "insurerProject", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Name of the setting value you are looking for. Supports partial, case-insensitive matching with one setting name, or exact matching with multiple comma-separated setting names.", "explode" : true, "in" : "query", "name" : "setting", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Value of the setting you are searching for. Not recommend for use with secrets, the search will be comparing the hashed value for the secret instead of the secret itself. Supports exact match only and requires the 'setting' parameter.", "explode" : true, "in" : "query", "name" : "setting-value", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "The specific layer type to search for: [deployment, environment_level, insurer_project, project_planet_class, tenant_default].\n\n**Tips:**\n- When searching by layer-type `deployment`, include a `deploymentId` to narrow results to a single **Deployment**.\n- When searching by layer-type `environment_level`, include an `environment` to narrow results to a single **Orbit**.\n- When searching by layer-type `insurer_project`, include a `insurerProject` to narrow results to a single **Star**.\n- When searching by layer-type `project_planet_class`, include `insurerProject` and `environment` to narrow results to a single **Star + Orbit**.\n", "explode" : true, "in" : "query", "name" : "layer-type", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "GRN of deployment - exact match only.

Supports searching by multiple comma-separated deployment IDs. Deployment IDs must belong to a single application. The general format of the deploymentId is {grn}:{version}:{app}:{insurer-code}:{insurer-project}:{supercluster}:{quadrant}:{planet-class}:{planet}:{resource_id}", "explode" : true, "in" : "query", "name" : "deploymentId", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "When true allows for partial name matching on application name and / or setting name(s).", "explode" : true, "in" : "query", "name" : "lenient", "required" : false, "schema" : { "type" : "boolean" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SettingValueListWrapper" } } }, "description" : "Successful operation" }, "401" : { "description" : "Unauthorized" } }, "summary" : "Find setting values", "tags" : [ "setting-values" ] }, "post" : { "description" : "Create a new setting value

Security - caller must have {appname}.write role.", "operationId" : "createSettingValue", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/SettingValueWrapper" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SettingValueWrapper" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Create a setting value", "tags" : [ "setting-values" ] } }, "/v1/setting-values/{settingValueId}" : { "delete" : { "description" : "Delete a setting value

Security - caller must have {appname}.write role.", "operationId" : "deleteSettingValue", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the setting value (surrogate key)", "explode" : false, "in" : "path", "name" : "settingValueId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "responses" : { "204" : { "description" : "Successful operation" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" } }, "summary" : "Delete a setting value", "tags" : [ "setting-values" ] }, "get" : { "description" : "Retrieve the details of a setting value

Security

", "operationId" : "getSettingValue", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the setting value (surrogate key)", "explode" : false, "in" : "path", "name" : "settingValueId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, { "description" : "True if secret setting values should be decrypted in the response", "explode" : true, "in" : "query", "name" : "decrypt", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "form" }, { "description" : "Reason for accessing decrypted setting - required when decrypt=true", "explode" : true, "in" : "query", "name" : "decrypt-reason", "required" : false, "schema" : { "minLength" : 3, "nullable" : true, "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SettingValueWrapper" } } }, "description" : "Successful operation" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" } }, "summary" : "Get a setting value", "tags" : [ "setting-values" ] }, "put" : { "description" : "Provides a way to update an existing setting value.

Version is required in order to prevent concurrent updates

Security - caller must have {appname}.write role.", "operationId" : "updateSettingValue", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the setting value (surrogate key)", "explode" : false, "in" : "path", "name" : "settingValueId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/SettingValueWrapper" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SettingValueWrapper" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Update a setting value.", "tags" : [ "setting-values" ] } }, "/v1/setting-values/_batch" : { "post" : { "description" : "Allows the caller to create, update, and/or delete multiple setting values in a single atomic transaction.

Optimistic Locking - version is required for update operations and should match the version number returned by GET /setting-values/{settingValueId}.

Security - caller must have {appname}.write role.", "operationId" : "executeBatchSettingValues", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/BatchSettingValuesRequestWrapper" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchSettingValuesResponseWrapper" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Update multiple setting values", "tags" : [ "setting-values" ] } }, "/v1/setting-values/_clone" : { "post" : { "description" : "Allows the caller to clone / copy setting values to a destination layer type and layer criteria in a single atomic transaction. For example, this could be used to clone selected setting values from one deployment to another deployment.

Security - caller must have {appname}.write role.", "operationId" : "cloneSettingValues", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/CloneSettingValuesRequest" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CloneSettingValuesResponse" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Clone setting values", "tags" : [ "setting-values" ] } }, "/v1/setting-values/{settingValueId}/history" : { "get" : { "description" : "Allows the caller to retrieve every version of this setting that existed.

Versions are returned in descending order and the currently effective version will have a null endDate.

Security - caller must have {appname}.read role.", "operationId" : "executeHistoryQuery", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the setting value (surrogate key)", "explode" : false, "in" : "path", "name" : "settingValueId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HistoryQueryResponseWrapper" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found

The search criteria did not resolve to a setting.

Note: Although audit logs exist for deleted settings, this endpoint does not currently support retrieving history for deleted settings." } }, "summary" : "Get the history of a given setting", "tags" : [ "setting-values" ] } }, "/v1/springClient/deploymentId/deploymentId" : { "get" : { "description" : "Returns the settings for a single application and environment.

This endpoint is for applications to load configuration for a specific deployment. The response contains settings from all applicable layers merged into a single response. If the any.tenant scope is used, the configuration for all tenants (same application and deployment) are also included.

Security - caller must have {appname}.read role. Caller must also have secret-read role to unmask secrets. The 'any.tenant' scope is required for multi-tenanted applications.", "operationId" : "getSpringConfig", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "GRN of the deployment", "explode" : true, "in" : "query", "name" : "deploymentId", "required" : true, "schema" : { "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Environment" } } }, "description" : "OK" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" } }, "summary" : "Provides settings formatted for spring clients", "tags" : [ "springClient" ] } }, "/v1/client/confidential/_effective-settings" : { "get" : { "description" : "Returns the effective settings for the environment.

This endpoint is for applications to load configuration for a specific deployment. The response contains settings from all applicable layers merged into the effective configuration. If the any.tenant scope is used, the configuration for all tenants (same application and deployment) are also included.

Security - caller must have {appname}.read role. Caller must also have secret-read role to unmask secrets.", "operationId" : "getEffectiveConfigNew", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "GRN for the deployment. Format: grn:version:app:tenant:star:isolation-zone:quadrant:orbit:planet:/deployment/galaxy", "explode" : true, "in" : "query", "name" : "deploymentId", "required" : true, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "If set to true, metadata about the setting values is returned in the response.", "explode" : true, "in" : "query", "name" : "debug", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EffectiveConfigCompositeResponseWrapper" } } }, "description" : "OK" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" } }, "summary" : "Returns the effective settings in a client optimized format", "tags" : [ "client" ] } }, "/v1/client/public/_effective-settings" : { "get" : { "description" : "Returns the effective settings and for the environment. The response contains settings from all applicable layers merged into the effective configuration.

This endpoint is only loading the configuration for public (SPA) applications. All other applications should use the `/client/confidential/_effective-settings` endpoint.

Security - The endpoint does not require authentication.", "operationId" : "getPublicEffectiveConfig", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "GRN for the deployment. Format: grn:version:app:tenant:star:isolation-zone:quadrant:orbit:planet:/deployment/galaxy", "explode" : true, "in" : "query", "name" : "deploymentId", "required" : true, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Insurer code to use for tenant overrides. This is required if insurerProject is supplied.", "explode" : true, "in" : "query", "name" : "insurerCode", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Insurer project for project overrides.", "explode" : true, "in" : "query", "name" : "insurerProject", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Planet class for project/planet_class overrides. Ignored when 'insurerProject' is not present.", "explode" : true, "in" : "query", "name" : "planetClass", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "If set to true, metadata about the setting values is returned in the response.", "explode" : true, "in" : "query", "name" : "debug", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EffectiveConfigResponseWrapper" } } }, "description" : "OK" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" }, "403" : { "description" : "Forbidden. This deploymentId is associated with a confidential application. Please use `GET /client/confidential/_effective-settings` instead." }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" } }, "summary" : "Returns the effective settings in a client optimized format for public applications", "tags" : [ "client" ] } }, "/v1/applications" : { "get" : { "description" : "Provides a way to search for application. If no criteria is specified, all applications are listed.

Security - caller must be authenticated", "operationId" : "getAllApplications", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "1 based, number of elements to be viewed per page. Default is 100.", "explode" : true, "in" : "query", "name" : "pageSize", "required" : false, "schema" : { "default" : 100, "type" : "integer" }, "style" : "form" }, { "description" : "token to query next page results ", "explode" : true, "in" : "query", "name" : "nextPageToken", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "limit results based on tenancyType", "explode" : true, "in" : "query", "name" : "tenancyType", "required" : false, "schema" : { "$ref" : "#/components/schemas/TenancyType" }, "style" : "form" }, { "description" : "The name of the application you are searching for. Supports partial, case-insensitive matching", "explode" : true, "in" : "query", "name" : "application", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Defines how the application name is matched. Searching is case-insensitive.\n\nStrategies:\n* `contains` - Partial match (Default)\n* `starts-with` - Match from the beginning of the name\n* `exact` - Exact match\n", "explode" : true, "in" : "query", "name" : "nameMatchStrategy", "required" : false, "schema" : { "enum" : [ "contains", "starts-with", "exact" ], "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/Application" }, "type" : "array" } } }, "description" : "Successful operation", "headers" : { "x-gwre-next-page-token" : { "description" : "The token to query next set of results, will only appear if there is a next page of results.", "explode" : false, "schema" : { "type" : "string" }, "style" : "simple" } } } }, "summary" : "Search for applications", "tags" : [ "applications" ] }, "post" : { "description" : "Register a new application.

Security - caller must have application-create role.", "operationId" : "createApplication", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/Application" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Application" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Create an application.", "tags" : [ "applications" ] } }, "/v1/applications/{applicationId}" : { "delete" : { "description" : "Delete the application. Currently cannot be deleted unless all associated settings are removed first. Deleting the application will delete all setting definitions associated with the application.

Security - caller must have admin-global role.", "operationId" : "deleteApplication", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "responses" : { "default" : { "description" : "Successful operation" } }, "summary" : "Delete an application", "tags" : [ "applications" ] }, "get" : { "description" : "Get the details of an application.

Security - caller must have {appname}.read role.", "operationId" : "getApplication", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Application" } } }, "description" : "Successful operation" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" } }, "summary" : "Get an application.", "tags" : [ "applications" ] }, "put" : { "description" : "Updates an existing application.

Version is required in order to prevent concurrent updates

Security - caller must have {appname}.write role.", "operationId" : "updateApplication", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/Application" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Application" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Update an application.", "tags" : [ "applications" ] } }, "/v1/applications/{applicationId}/roles" : { "get" : { "description" : "List all roles for a given application.

Security - caller must have {appname}.read role.", "operationId" : "getApplicationRoles", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/Role" }, "type" : "array" } } }, "description" : "Successful operation" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Internal Server Error" } }, "summary" : "Search for roles", "tags" : [ "applications" ] } }, "/v1/applications/{applicationId}/rolemappings" : { "get" : { "description" : "List all role mappings for the application.

Security - caller must have {appname}.read role.", "operationId" : "getRoleMappingsForApplication", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/RoleMappingView" }, "type" : "array" } } }, "description" : "Successful operation" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Internal Server Error" } }, "summary" : "Search for role mappings", "tags" : [ "applications" ] }, "post" : { "description" : "Assign a user / client to a role for the application.

NOTE: It is preferred that rolemappings are created for pods using groupName, or for Keti apps / clients using emailAddress. Rolemapping assignments using a user email should only be created if necessary.

Security - caller must have {appname}.owner role.", "operationId" : "createRoleMappingForApplication", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/RoleMappingCreateRequest" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RoleMappingView" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Assign a user / client to a role for the application", "tags" : [ "applications" ] } }, "/v1/applications/{applicationId}/rolemappings/{roleMappingId}" : { "delete" : { "description" : "Deletes a role mapping from an application

Security - caller must have {appname}.owner role.", "operationId" : "deleteRoleMappingForApplication", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, { "description" : "Identifies the role mapping (surrogate key)", "explode" : false, "in" : "path", "name" : "roleMappingId", "required" : true, "schema" : { "format" : "int64", "type" : "integer" }, "style" : "simple" } ], "responses" : { "204" : { "description" : "Successful operation" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Internal Server Error" } }, "summary" : "Delete a role mapping", "tags" : [ "applications" ] } }, "/v1/applications/{applicationId}/scopes" : { "post" : { "description" : "Grant a scope for an application role.

Security - caller must have {appname}.owner role. To grant scope for owner role, caller must be an admin.", "operationId" : "grantScopeForApplication", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/ApplicationScopeRequest" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationScopeWrapper" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Grant scope", "tags" : [ "applications" ] } }, "/v1/applications/{applicationId}/setting-definitions" : { "get" : { "description" : "Provides a way to search for setting definitions for a given application. If no criteria is specified, all of the setting definitions for the application are returned in a paginated format.

Security - caller must have {appname}.read role.", "operationId" : "getAllApplicationSettingDefinitions", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, { "description" : "1 based, number of elements to be viewed per page. Default is 100.", "explode" : true, "in" : "query", "name" : "pageSize", "required" : false, "schema" : { "default" : 100, "type" : "integer" }, "style" : "form" }, { "description" : "token to query next page results ", "explode" : true, "in" : "query", "name" : "nextPageToken", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Name of the setting definition you are looking for, supports partial value and is case-insensitive.", "explode" : true, "in" : "query", "name" : "settingName", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "if true, returns the list of subscribed setting definitions.", "explode" : true, "in" : "query", "name" : "subscribedOnly", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SettingDefinitionResponseListWrapper" } } }, "description" : "Successful operation", "headers" : { "x-gwre-next-page-token" : { "description" : "The token to query next set of results, will only appear if there is a next page of results.", "explode" : false, "schema" : { "type" : "string" }, "style" : "simple" } } } }, "summary" : "Find the setting definitions for an application", "tags" : [ "applications" ] }, "post" : { "description" : "Create a setting definition for an application.

Security - caller must have {appname}.[owner|write|definition-mgr] role.", "operationId" : "createApplicationSettingDefinition", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/SettingDefinitionRequestWrapper" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SettingDefinitionResponseWrapper" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" } }, "summary" : "Creates a setting definition for an application", "tags" : [ "applications" ] } }, "/v1/applications/{applicationId}/setting-definitions/{settingDefinitionId}" : { "delete" : { "description" : "Deletes a setting definition of a application. This is only allowed when there are no setting values associated to the setting definition for other tenants.

Security - caller must have {appname}.owner role.", "operationId" : "deleteApplicationSettingDefinition", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, { "description" : "Identifies the setting definition (surrogate key)", "explode" : false, "in" : "path", "name" : "settingDefinitionId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "responses" : { "default" : { "description" : "Successful operation" } }, "summary" : "Delete a setting definition for an application", "tags" : [ "applications" ] }, "get" : { "description" : "Get the details of a setting definition.

Security - caller must have {appname}.read role.", "operationId" : "getApplicationSettingDefinition", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, { "description" : "Identifies the setting definition (surrogate key)", "explode" : false, "in" : "path", "name" : "settingDefinitionId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SettingDefinitionResponseWrapper" } } }, "description" : "Successful operation" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" } }, "summary" : "Get a specific setting definition for an application", "tags" : [ "applications" ] }, "put" : { "description" : "Updates an existing setting definition for an application.

Security - caller must have {appname}.[owner|write|definition-mgr] role.

Version is required in order to prevent concurrent updates

There are field specific restrictions. See model definition for details.", "operationId" : "updateApplicationSettingDefinition", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, { "description" : "Identifies the setting definition (surrogate key)", "explode" : false, "in" : "path", "name" : "settingDefinitionId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/SettingDefinitionRequestWrapper" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SettingDefinitionResponseWrapper" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Update a setting definition for an application", "tags" : [ "applications" ] } }, "/v1/applications/{applicationId}/setting-definitions/{settingDefinitionId}/_share" : { "post" : { "description" : "Sharing a setting with another application permits the target application to subscribe one or more settings in that application to this setting.\n\nNote: Settings in a customer developed application may only safelist other customer developed applications.\n\nSecurity - caller must have {appname}.owner role.", "operationId" : "shareSettingDefinition", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, { "description" : "Identifies the setting definition (surrogate key)", "explode" : false, "in" : "path", "name" : "settingDefinitionId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/SettingDefinitionShareRequestWrapper" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SettingDefinitionResponseWrapper" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" } }, "summary" : "Shares the setting with an application", "tags" : [ "beta" ] } }, "/v1/applications/{applicationId}/setting-definitions/{settingDefinitionId}/_subscribe" : { "post" : { "description" : "Creates a subscription to a shared setting definition. A subscription will cause all updates to the shared setting's values to also be applied to the values for this setting. If called with no parameters and setting values for the setting definition on the publisher side and subscriber side match, the subscription will be enabled.

Security - caller must have owner role for the subscriber.", "operationId" : "subscribeSettingDefinition", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, { "description" : "Identifies the setting definition (surrogate key)", "explode" : false, "in" : "path", "name" : "settingDefinitionId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, { "description" : "If true, subscription will not be created, response will include any differences between publisher and subscriber that must be resolved for the subscription to be created, as well as a code to force overwrite of these differences for the subscriber. Defaults to false if not supplied.", "explode" : true, "in" : "query", "name" : "dryRun", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "form" }, { "description" : "If true:\n * if there are no setting values for the setting definition on the subscriber side of the relationship, the publisher's setting values will be copied over to the subscriber before the subscription is enabled.\n * If there are no setting values for the setting definition on the publisher side of the relationship (which can only occur on the first subscription), the subscriber's setting values will be copied over to the publisher before the subscription is enabled.\n * If there are setting values on both sides and they match, the subscription will be applied. Is the same as copyToEmptySideOfSubscription = false\n

Defaults to false if not supplied. Values that will be copied will match the dryRun response missing publisher values", "explode" : true, "in" : "query", "name" : "copyToEmptySideOfSubscription", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "form" }, { "description" : "If provided, creates a subscription and overwrites subscriber's setting values. The overwriteSubscriberValuesCode value can be retrieved from a subscription dryRun response.\n * You cannot set overwriteSubscriberValuesCode param along with copyToEmptySideOfSubscription or dryRun params set to true.\n * If there are conflicting setting values and the overwriteSubscriberValuesCode is not provided, an error will occur.", "explode" : true, "in" : "query", "name" : "overwriteSubscriberValuesCode", "required" : false, "schema" : { "type" : "string" }, "style" : "form" } ], "requestBody" : { "$ref" : "#/components/requestBodies/SubscriptionRequestWrapper" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionResponseWrapper" } } }, "description" : "Subscription created successfully" }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionResponseWrapper" } } }, "description" : "Successful dry run, subscription not created" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Internal Server Error" } }, "summary" : "Subscribe to a published setting", "tags" : [ "beta" ] } }, "/v1/applications/{applicationId}/setting-definitions/{settingDefinitionId}/_unsubscribe" : { "post" : { "description" : "Current values of this setting will remain, but changes to the shared setting will no longer be reflected in this setting.

Security - caller must have owner role.", "operationId" : "unsubscribe", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, { "description" : "Identifies the setting definition (surrogate key)", "explode" : false, "in" : "path", "name" : "settingDefinitionId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "responses" : { "204" : { "description" : "Successful operation" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" } }, "summary" : "Unsubscribe a setting definition", "tags" : [ "beta" ] } }, "/v1/applications/{applicationId}/setting-definitions/{settingDefinitionId}/setting-values/history" : { "get" : { "description" : "Allows the caller to retrieve every version of every setting value that existed across all layers for the given setting definition.

Versions are returned in descending order of ID and then revision timestamp.

Security - caller must have {appname}.read role.", "operationId" : "getApplicationSettingDefinitionHistory", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, { "description" : "Identifies the setting definition (surrogate key)", "explode" : false, "in" : "path", "name" : "settingDefinitionId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, { "deprecated" : true, "description" : "Deprecated on 12/2021 - 0 based, index of the page to be viewed", "explode" : true, "in" : "query", "name" : "pageOffset", "required" : false, "schema" : { "default" : 0, "type" : "integer" }, "style" : "form" }, { "description" : "1 based, number of elements to be viewed per page. Default is 100.", "explode" : true, "in" : "query", "name" : "pageSize", "required" : false, "schema" : { "default" : 100, "type" : "integer" }, "style" : "form" }, { "description" : "token to query next page results ", "explode" : true, "in" : "query", "name" : "nextPageToken", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "The value of the setting to look for in the audit history. If used, the records where the value was introduced and removed will be returned in the results.", "explode" : true, "in" : "query", "name" : "value", "required" : false, "schema" : { "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SettingDefinitionHistoryQueryResponse" } } }, "description" : "Successful operation" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" } }, "summary" : "Get history of setting values associated with this setting definition by application and tenant", "tags" : [ "applications" ] } }, "/v1/applications/{applicationId}/authorize-client" : { "post" : { "description" : "Authorizes the specified application or service to read its own effective configuration, including secrets, from Helios.

If your application is registered in multiple authorization servers, you must authorize each client ID individually.

Application declared as 'isShared' cannot be authorized.

Security - caller must be the Guidewire application owner or a Helios admin.", "operationId" : "authorizeClient", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, { "description" : "If set to true, the response includes content that shows the scopes granted.", "explode" : true, "in" : "query", "name" : "debug", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "form" } ], "requestBody" : { "$ref" : "#/components/requestBodies/AuthorizeClientRequestWrapper" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizeClientResponse" } } }, "description" : "Successful operation (returned when debug=true)" }, "204" : { "description" : "Successful operation (returned when debug=false)" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Authorize client application.", "tags" : [ "applications" ] } }, "/v1/applications/_authorize-customer-access" : { "post" : { "description" : "Creates groups in Guidewire Hub for the given __applicationGroup__ and __role__. \nThis endpoint will create and safelist a group per insurer project (including the special ‘all’ project) and planet-class category.\n\nGroup Format: {insurer-code}.{planet-class-category}.{insurer-project}.{planet}.helios.{application-group}-{role}\n\n1. __insurer-code__ the tenant indicated in the request.\n2. __planet-class-category__ one of: _lower_, _preprod_ or _prod_\n3. __insurer-project__: logical insurer project of _all_\n4. __planet__: currently only _all_ is supported\n5. __application_group__: currently only _ig_ is supported\n6. __role__: currently only _user_ is supported\n\nFor example, assuming a tenant has 10 insurer projects this endpoint will create and safelist 33 groups: (number of Projects + all) * number of planet-class-categories. \nExamples: _acme.lower.gwcp.all.helios.ig-user_, _acme.prod.all.all.helios.ig-user_, ...\n\nSecurity - caller must be an application group owner or a global admin.\n", "operationId" : "authorizeCustomerAccessV2", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/AuthorizeCustomerAccessV2RequestWrapper" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizeCustomerAccessResponse" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Authorize Customer Access to an Application Group", "tags" : [ "beta" ] } }, "/v1/applications/_authorize-customer-client" : { "post" : { "description" : "Authorizes a client to use a group of applications bounded by the given orbit and star.\n\nRole Format: ...all.helios.ig-user\n\n1. __tenant__ the tenant indicated in the request.\n2. __orbit_category__ one of: _lower_, _preprod_ or _prod_\n3. __star__: logical insurer project of _all_\n4. __app_group__: currently only _ig_ is supported\n\nSecurity - caller must be a global admin.\n", "operationId" : "authorizeCustomerClient", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/AuthorizeCustomerClientAccessRequestWrapper" }, "responses" : { "204" : { "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Authorize an okta client to an Application Group", "tags" : [ "beta" ] } }, "/v1/rolemappings" : { "get" : { "description" : "Provides a way to search for role mapping. If no criteria is specified, all rolemappings are listed.

Security - caller must have admin-global role.", "operationId" : "getAllRoleMappings", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "1 based, number of elements to be viewed per page. Default is 100.", "explode" : true, "in" : "query", "name" : "pageSize", "required" : false, "schema" : { "default" : 100, "type" : "integer" }, "style" : "form" }, { "description" : "token to query next page results ", "explode" : true, "in" : "query", "name" : "nextPageToken", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "The email address within the role mapping you are searching for. Supports partial, case-insensitive matching", "explode" : true, "in" : "query", "name" : "emailAddress", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "The name of the group within the role mapping you are searching for. Supports partial, case-insensitive matching", "explode" : true, "in" : "query", "name" : "group", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "The name of the role you are filtering the role mapping by. Supports partial, case-insensitive matching", "explode" : true, "in" : "query", "name" : "role", "required" : false, "schema" : { "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/RoleMappingView" }, "type" : "array" } } }, "description" : "Successful operation", "headers" : { "x-gwre-next-page-token" : { "description" : "The token to query next set of results, will only appear if there is a next page of results.", "explode" : false, "schema" : { "type" : "string" }, "style" : "simple" } } } }, "summary" : "Search for rolemappings", "tags" : [ "rolemappings" ] }, "post" : { "description" : "Map a user or group to a role

Security - caller must have admin-global role.", "operationId" : "createRoleMapping", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/RoleMappingCreateRequest" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RoleMappingView" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" } }, "summary" : "Assign a user to a role", "tags" : [ "rolemappings" ] } }, "/v1/rolemappings/{roleMappingId}" : { "delete" : { "description" : "Delete the role mapping. Currently cannot be deleted unless all associated settings are removed first.

Security - caller must have admin-global `role`.", "operationId" : "deleteRoleMapping", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the role mapping (surrogate key)", "explode" : false, "in" : "path", "name" : "roleMappingId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "responses" : { "default" : { "description" : "Successful operation" } }, "summary" : "Delete a role mapping", "tags" : [ "rolemappings" ] }, "get" : { "description" : "Get the details of a role mapping.

Security - caller must have admin-global role.", "operationId" : "getRoleMapping", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the role mapping (surrogate key)", "explode" : false, "in" : "path", "name" : "roleMappingId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RoleMappingView" } } }, "description" : "Successful operation" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" } }, "summary" : "Get a role mapping.", "tags" : [ "rolemappings" ] } }, "/v1/applications/{applicationId}/deployments" : { "get" : { "description" : "Provides a way to search for deployments. If no criteria is specified, all deployments for the application are listed.

Deployment ID cannot be used in search along with any other parameter.

Security - caller must have the read role for the application.", "operationId" : "getAllDeployments", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, { "description" : "1 based, number of elements to be viewed per page. Default is 100.", "explode" : true, "in" : "query", "name" : "pageSize", "required" : false, "schema" : { "default" : 100, "type" : "integer" }, "style" : "form" }, { "description" : "token to query next page results ", "explode" : true, "in" : "query", "name" : "nextPageToken", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Planet of the deployment you are searching for. Supports partial, case-insensitive matching", "explode" : true, "in" : "query", "name" : "planet", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "The planet class you are filtering by. Supports partial, case-insensitive matching", "explode" : true, "in" : "query", "name" : "planetClass", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "GRN of deployment - exact match only", "explode" : true, "in" : "query", "name" : "deploymentId", "required" : false, "schema" : { "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeploymentListWrapper" } } }, "description" : "Successful operation" } }, "summary" : "Search for all deployments for an application", "tags" : [ "applications" ] }, "post" : { "description" : "Registers a deployment.\n\n

Security - caller must have owner role for the application.", "operationId" : "createDeployment", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/DeploymentWrapper" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeploymentWrapper" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Register a deployment.", "tags" : [ "applications" ] } }, "/v1/applications/{applicationId}/deployments/{deploymentId}" : { "delete" : { "description" : "Delete a deployment

Security - caller must have owner role for the application.", "operationId" : "deleteDeployment", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, { "description" : "Identifies the deployment (surrogate key)", "explode" : false, "in" : "path", "name" : "deploymentId", "required" : true, "schema" : { "format" : "int64", "type" : "integer" }, "style" : "simple" }, { "description" : "If true, setting values for the deployment will be deleted if they exist. Defaults to false if not supplied.", "explode" : true, "in" : "query", "name" : "force", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "form" } ], "responses" : { "default" : { "description" : "Successful operation" } }, "summary" : "Delete a deployment", "tags" : [ "applications" ] }, "get" : { "description" : "Get the details of a deployment.

Security - caller must have the read role for the application.", "operationId" : "getDeployment", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, { "description" : "Identifies the deployment (surrogate key)", "explode" : false, "in" : "path", "name" : "deploymentId", "required" : true, "schema" : { "format" : "int64", "type" : "integer" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeploymentWrapper" } } }, "description" : "Successful operation" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" } }, "summary" : "Get a deployment's details.", "tags" : [ "applications" ] }, "put" : { "description" : "Updates deployment ID mapping for an existing deployment

Version is required in order to prevent concurrent updates

Security - caller must have owner role for the application.", "operationId" : "updateDeployment", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, { "description" : "Identifies the deployment (surrogate key)", "explode" : false, "in" : "path", "name" : "deploymentId", "required" : true, "schema" : { "format" : "int64", "type" : "integer" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/DeploymentWrapper" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeploymentWrapper" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Update a deployment.", "tags" : [ "applications" ] } }, "/setting-values/v2" : { "get" : { "description" : "Provides a way to search for setting values. If no criteria is specified, all setting values are listed.

Security - caller must have {appname}.read role.", "operationId" : "getAllSettingValuesV2", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "1 based, number of elements to be viewed per page. Default is 100.", "explode" : true, "in" : "query", "name" : "pageSize", "required" : false, "schema" : { "default" : 100, "type" : "integer" }, "style" : "form" }, { "description" : "token to query next page results ", "explode" : true, "in" : "query", "name" : "nextPageToken", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Name of the application whose setting values you are searching for.\nSupports partial, case-insensitive matching.\n\n**Tip:**\nIt's strongly recommended that one always include an `application` name in their search for best performance.\n", "explode" : true, "in" : "query", "name" : "application", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Name (case-insensitive) of the **Orbit** whose setting values you are searching for.\n\n**This attribute is only used when `layer-type` is set to `orbit` or `star_orbit`.**\n", "explode" : true, "in" : "query", "name" : "orbit", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Name (case-insensitive) of the **Star** whose setting values you are searching for.\n\n**This attribute is only used when `layer-type` is set to `star`, `star_orbit` or `planet`.**\n", "explode" : true, "in" : "query", "name" : "star", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Name of the setting value you are looking for. Supports partial, case-insensitive matching with one setting name, or exact matching with multiple comma-separated setting names.", "explode" : true, "in" : "query", "name" : "setting", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Value of the setting you are searching for. Not recommend for use with secrets, the search will be comparing the hashed value for the secret instead of the secret itself. Supports exact match only and requires the 'setting' parameter.", "explode" : true, "in" : "query", "name" : "setting-value", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "The specific layer type to search for: [deployment, planet, orbit, star, star_orbit, tenant_default, isolation_zone].\n\n**Tips:**\n- When searching by layer-type `deployment`, include a `deploymentId` to narrow results to a single **Deployment**.\n- When searching by layer-type `planet`, include `isolationZone`, `star` and `planet` to narrow results to a single **Planet**.\n- When searching by layer-type `orbit`, include an `orbit` to narrow results to a single **Orbit**.\n- When searching by layer-type `star`, include a `star` to narrow results to a single **Star**.\n- When searching by layer-type `star_orbit`, include `star` and `orbit` to narrow results to a single **Star + Orbit**.\n- When searching by layer-type `isolation_zone`, include an `isolationZone` to narrow results to a single **Isolation Zone**.\n", "explode" : true, "in" : "query", "name" : "layer-type", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "GRN of deployment - exact match only.

Supports searching by multiple comma-separated deployment IDs. Deployment IDs must belong to a single application. The general format of the deploymentId is {grn}:{version}:{app}:{tenant}:{star}:{isolation_zone}:{quadrant}:{orbit}:{planet}:{resource_id}", "explode" : true, "in" : "query", "name" : "deploymentId", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "When true allows for partial name matching on application name and / or setting name(s).", "explode" : true, "in" : "query", "name" : "lenient", "required" : false, "schema" : { "type" : "boolean" }, "style" : "form" }, { "description" : "Name (case-insensitive) of the **Planet** whose setting values you are searching for.\n\n**This attribute is only used when `layer-type` is set to `planet`.**\n", "explode" : true, "in" : "query", "name" : "planet", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Name (case-insensitive) of the **Isolation Zone** whose setting values you are searching for.\n\n**This attribute is only used when `layer-type` is set to `planet`.**\n", "explode" : true, "in" : "query", "name" : "isolationZone", "required" : false, "schema" : { "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SettingValueListV2Wrapper" } } }, "description" : "Successful operation" }, "401" : { "description" : "Unauthorized" } }, "summary" : "Find setting values", "tags" : [ "setting-values v2" ] }, "post" : { "description" : "Create a new setting value

Planet level settings temporarily require a 'deploymentId'. Including the 'deploymentId' ensures the setting is retrievable by the V1 API.

Security - caller must have {appname}.write role.", "operationId" : "createSettingValueV2", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/SettingValueV2Wrapper" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SettingValueV2Wrapper" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Create a setting value", "tags" : [ "setting-values v2" ] } }, "/setting-values/v2/{settingValueId}" : { "delete" : { "description" : "Delete a setting value

Security - caller must have {appname}.write role.", "operationId" : "deleteSettingValueV2", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the setting value (surrogate key)", "explode" : false, "in" : "path", "name" : "settingValueId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "responses" : { "204" : { "description" : "Successful operation" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" } }, "summary" : "Delete a setting value", "tags" : [ "setting-values v2" ] }, "get" : { "description" : "Retrieve the details of a setting value

Security

", "operationId" : "getSettingValueV2", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the setting value (surrogate key)", "explode" : false, "in" : "path", "name" : "settingValueId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, { "description" : "True if secret setting values should be decrypted in the response", "explode" : true, "in" : "query", "name" : "decrypt", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "form" }, { "description" : "Reason for accessing decrypted setting - required when decrypt=true", "explode" : true, "in" : "query", "name" : "decrypt-reason", "required" : false, "schema" : { "minLength" : 3, "nullable" : true, "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SettingValueV2Wrapper" } } }, "description" : "Successful operation" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" } }, "summary" : "Get a setting value", "tags" : [ "setting-values v2" ] }, "put" : { "description" : "Provides a way to update an existing setting value.

Version is required in order to prevent concurrent updates

Planet level settings temporarily require a 'deploymentId'. Including the 'deploymentId' ensures the setting is retrievable by the V1 API.

Security - caller must have {appname}.write role.", "operationId" : "updateSettingValueV2", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the setting value (surrogate key)", "explode" : false, "in" : "path", "name" : "settingValueId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/SettingValueV2Wrapper" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SettingValueV2Wrapper" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Update a setting value.", "tags" : [ "setting-values v2" ] } }, "/setting-values/v2/{settingValueId}/history" : { "get" : { "description" : "Allows the caller to retrieve every version of this setting that existed.

Versions are returned in descending order and the currently effective version will have a null endDate.

Security - caller must have {appname}.read role.", "operationId" : "executeHistoryQueryV2", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the setting value (surrogate key)", "explode" : false, "in" : "path", "name" : "settingValueId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/HistoryQueryResponseV2Wrapper" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found

The search criteria did not resolve to a setting.

Note: Although audit logs exist for deleted settings, this endpoint does not currently support retrieving history for deleted settings." } }, "summary" : "Get the history of a given setting", "tags" : [ "setting-values v2" ] } }, "/setting-values/v2/_batch" : { "post" : { "description" : "Allows the caller to create, update, and/or delete multiple setting values in a single atomic transaction.

Optimistic Locking - version is required for update operations and should match the version number returned by GET /setting-values/{settingValueId}.

Security - caller must have {appname}.write role.", "operationId" : "executeBatchSettingValuesV2", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/BatchSettingValuesRequestV2Wrapper" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchSettingValuesResponseV2Wrapper" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Update multiple setting values", "tags" : [ "setting-values v2" ] } }, "/setting-values/v2/_clone" : { "post" : { "description" : "Allows the caller to clone / copy setting values to a destination layer type and layer criteria in a single atomic transaction. For example, this could be used to clone selected setting values from one deployment to another deployment.

Security - caller must have {appname}.write role.", "operationId" : "cloneSettingValuesV2", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/CloneSettingValuesRequestV2" }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CloneSettingValuesResponseV2" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Clone setting values", "tags" : [ "setting-values v2" ] } }, "/v1/secret-rotations" : { "get" : { "description" : "Retrieves a list of active or past secret rotations matching the specified filter criteria.

Note: This endpoint is not yet implemented and will be available in a future release.

Security - caller must have {appname}.write role.", "operationId" : "getAllSecretRotations", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "1 based, number of elements to be viewed per page. Default is 100.", "explode" : true, "in" : "query", "name" : "pageSize", "required" : false, "schema" : { "default" : 100, "type" : "integer" }, "style" : "form" }, { "description" : "token to query next page results ", "explode" : true, "in" : "query", "name" : "nextPageToken", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Optional filter that returns only secret rotations associated with a specific application name.", "explode" : true, "in" : "query", "name" : "application", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Optional filter that restricts results to secret rotations in the specified status.", "explode" : true, "in" : "query", "name" : "status", "required" : false, "schema" : { "$ref" : "#/components/schemas/SecretRotationStatus" }, "style" : "form" }, { "description" : "Optional filter by setting name. Only secret rotations associated with the specified setting are returned.", "explode" : true, "in" : "query", "name" : "setting", "required" : false, "schema" : { "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SecretRotationListWrapper" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" } }, "summary" : "Search secret rotations - NOT IMPLEMENTED (future)", "tags" : [ "secret-rotations" ] }, "post" : { "description" : "Allows the caller to manually trigger the secret rotation process for a given secret setting value.

Note: This endpoint is not yet implemented and will be available in a future release.

Security - caller must have {appname}.write role.", "operationId" : "createSecretRotation", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" } ], "requestBody" : { "$ref" : "#/components/requestBodies/SecretRotationRequest" }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SecretRotationWrapper" } } }, "description" : "Successful operation" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" } }, "summary" : "Start a new secret rotation - NOT IMPLEMENTED (future)", "tags" : [ "secret-rotations" ] } }, "/v1/secret-rotations/{rotationId}" : { "get" : { "description" : "Retrieve the details of a secret rotation.

Note: This endpoint is not yet implemented and will be available in a future release.

Security - caller must have {appname}.read role.", "operationId" : "getSecretRotation", "parameters" : [ { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, { "description" : "Identifies the secret rotation (surrogate key)", "explode" : false, "in" : "path", "name" : "rotationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SecretRotationWrapper" } } }, "description" : "Successful operation" }, "401" : { "description" : "Unauthorized" }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "404" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" } }, "summary" : "Get a secret rotation - NOT IMPLEMENTED (future)", "tags" : [ "secret-rotations" ] } } }, "components" : { "parameters" : { "gwTenantHeader" : { "description" : "Indicates the tenant. If not passed, it defaults to guidewire but only temporarily. It will be required in the near future.

This header is ignored when `GW-Request-GRN` is also supplied.", "explode" : false, "in" : "header", "name" : "GW-Tenant", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, "gwUserHeader" : { "description" : "Indicates the user on whose behalf the request was made when client credentials are used (service to service). The value should be set to the user's UID. This can be found in the uid attribute of the user's JWT. For requests using Postman (or similar tool) with client credentials, your UID can be obtained through the Keti API (GET /users).

This header is currently optional but it will be required in the future for any operation that updates data with a client token acquired using client credentials.", "explode" : false, "in" : "header", "name" : "GW-User", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, "testRequestHeader" : { "description" : "Indicates that any resources created as part of the request will be considered test data and will be automatically purged. The amount of time before the resource is purged varies by resource type.", "explode" : false, "in" : "header", "name" : "Gw-TestRequest", "required" : false, "schema" : { "default" : false, "type" : "boolean" }, "style" : "simple" }, "gwRequestGrnHeader" : { "description" : "Used to pass multiple attributes such as tenant, project, planet class, etc of the caller or originator of the request. See [Guidewire Resource Notation](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation) for additional details.

Note: Helios only uses the insurer-code from this header. All other attributes are ignored.", "explode" : false, "in" : "header", "name" : "GW-Request-GRN", "required" : false, "schema" : { "type" : "string" }, "style" : "simple" }, "pageOffsetQueryParam" : { "deprecated" : true, "description" : "Deprecated on 12/2021 - 0 based, index of the page to be viewed", "explode" : true, "in" : "query", "name" : "pageOffset", "required" : false, "schema" : { "default" : 0, "type" : "integer" }, "style" : "form" }, "pageQueryParam" : { "deprecated" : true, "description" : "0 based, value of the page being viewed", "explode" : true, "in" : "query", "name" : "page", "required" : false, "schema" : { "default" : 0, "type" : "integer" }, "style" : "form" }, "pageSizeQueryParam" : { "description" : "1 based, number of elements to be viewed per page. Default is 100.", "explode" : true, "in" : "query", "name" : "pageSize", "required" : false, "schema" : { "default" : 100, "type" : "integer" }, "style" : "form" }, "nextPageTokenParam" : { "description" : "token to query next page results ", "explode" : true, "in" : "query", "name" : "nextPageToken", "required" : false, "schema" : { "type" : "string" }, "style" : "form" }, "applicationIdPathParam" : { "description" : "Identifies the application (surrogate key)", "explode" : false, "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, "deploymentIdPathParam" : { "description" : "Identifies the deployment (surrogate key)", "explode" : false, "in" : "path", "name" : "deploymentId", "required" : true, "schema" : { "format" : "int64", "type" : "integer" }, "style" : "simple" }, "roleMappingIdPathParam" : { "description" : "Identifies the role mapping (surrogate key)", "explode" : false, "in" : "path", "name" : "roleMappingId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, "roleIdPathParam" : { "description" : "Identifies the role (surrogate key)", "explode" : false, "in" : "path", "name" : "roleId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, "rotationIdPathParam" : { "description" : "Identifies the secret rotation (surrogate key)", "explode" : false, "in" : "path", "name" : "rotationId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, "settingDefinitionIdPathParam" : { "description" : "Identifies the setting definition (surrogate key)", "explode" : false, "in" : "path", "name" : "settingDefinitionId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, "settingValueIdPathParam" : { "description" : "Identifies the setting value (surrogate key)", "explode" : false, "in" : "path", "name" : "settingValueId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" }, "tenantIdPathParam" : { "description" : "Identifies the tenant (surrogate key)", "explode" : false, "in" : "path", "name" : "tenantId", "required" : true, "schema" : { "$ref" : "#/components/schemas/id" }, "style" : "simple" } }, "requestBodies" : { "Tenant" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tenant" } } } }, "SettingValueWrapper" : { "content" : { "application/json" : { "examples" : { "DeploymentIdExample" : { "value" : { "data" : { "applicationId" : 1451, "name" : "settingName", "value" : "settingValue", "isTenantSpecific" : true, "comment" : "setting value comment", "applyTo" : { "layerType" : "deployment", "deploymentId" : "grn:v1:helios:::centaurus:local:local:bobsmith:/deployment/local" } } } }, "EnvironmentExample" : { "value" : { "data" : { "applicationId" : 1451, "name" : "settingName", "value" : "settingValue", "isTenantSpecific" : true, "comment" : "setting value comment", "applyTo" : { "layerType" : "environment_level", "environmentLevel" : "staging" } } } }, "TenantDefaultsExample" : { "value" : { "data" : { "applicationId" : 1451, "name" : "settingName", "value" : "settingValue", "isTenantSpecific" : true, "comment" : "setting value comment", "applyTo" : { "layerType" : "tenant_default" } } } }, "SuperGalaxyExample" : { "value" : { "data" : { "applicationId" : 1451, "name" : "settingName", "value" : "settingValue", "isTenantSpecific" : false, "comment" : "setting value comment", "applyTo" : { "layerType" : "super_galaxy", "superGalaxy" : "centaurus" } } } }, "ProjectExample" : { "value" : { "data" : { "applicationId" : 1451, "name" : "settingName", "value" : "settingValue", "isTenantSpecific" : true, "comment" : "setting value comment", "applyTo" : { "layerType" : "insurer_project", "insurerProject" : "projectA" } } } }, "ProjectPlanetClassExample" : { "value" : { "data" : { "applicationId" : 1451, "name" : "settingName", "value" : "settingValue", "isTenantSpecific" : true, "comment" : "setting value comment", "applyTo" : { "layerType" : "project_planet_class", "insurerProject" : "projectA", "planetClass" : "dev" } } } } }, "schema" : { "$ref" : "#/components/schemas/SettingValueWrapper" } } } }, "SettingValueV2Wrapper" : { "content" : { "application/json" : { "examples" : { "DeploymentExample" : { "value" : { "data" : { "applicationId" : 1451, "name" : "settingName", "value" : "settingValue", "isTenantSpecific" : true, "comment" : "setting value comment", "applyTo" : { "layerType" : "deployment", "deploymentId" : "grn:v1:helios:guidewire:project:amer-0:local:local:bobsmith:/deployment/local" } } } }, "PlanetExample" : { "value" : { "data" : { "applicationId" : 1451, "name" : "settingName", "value" : "settingValue", "isTenantSpecific" : true, "comment" : "setting value comment", "applyTo" : { "layerType" : "planet", "deploymentId" : "grn:v1:helios:guidewire:project:amer-0:local:local:bobsmith:/deployment/local", "isolationZone" : "amer-0", "star" : "project", "planet" : "bobsmith" } } } }, "OrbitExample" : { "value" : { "data" : { "applicationId" : 1451, "name" : "settingName", "value" : "settingValue", "isTenantSpecific" : true, "comment" : "setting value comment", "applyTo" : { "layerType" : "orbit", "orbit" : "staging" } } } }, "TenantDefaultsExample" : { "value" : { "data" : { "applicationId" : 1451, "name" : "settingName", "value" : "settingValue", "isTenantSpecific" : true, "comment" : "setting value comment", "applyTo" : { "layerType" : "tenant_default" } } } }, "IsolationZoneExample" : { "value" : { "data" : { "applicationId" : 1451, "name" : "settingName", "value" : "settingValue", "isTenantSpecific" : false, "comment" : "setting value comment", "applyTo" : { "layerType" : "isolation_zone", "isolationZone" : "amer-0" } } } }, "StarExample" : { "value" : { "data" : { "applicationId" : 1451, "name" : "settingName", "value" : "settingValue", "isTenantSpecific" : true, "comment" : "setting value comment", "applyTo" : { "layerType" : "star", "star" : "projectA" } } } }, "StarOrbitExample" : { "value" : { "data" : { "applicationId" : 1451, "name" : "settingName", "value" : "settingValue", "isTenantSpecific" : true, "comment" : "setting value comment", "applyTo" : { "layerType" : "star_orbit", "star" : "projectA", "orbit" : "dev" } } } } }, "schema" : { "$ref" : "#/components/schemas/SettingValueV2Wrapper" } } } }, "Application" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Application" } } }, "required" : true }, "AuthorizeClientRequestWrapper" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizeClientRequestWrapper" } } } }, "AuthorizeCustomerAccessV2RequestWrapper" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizeCustomerAccessV2RequestWrapper" } } } }, "AuthorizeCustomerClientAccessRequestWrapper" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizeCustomerClientAccessRequestWrapper" } } } }, "SettingDefinitionRequestWrapper" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SettingDefinitionRequestWrapper" } } } }, "SettingDefinitionShareRequestWrapper" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SettingDefinitionShareRequestWrapper" } } } }, "RoleMapping" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RoleMapping" } } } }, "RoleMappingCreateRequest" : { "content" : { "application/json" : { "examples" : { "withGroupName" : { "summary" : "PodNameExample", "value" : { "groupName" : "pod-example", "role" : "write" } }, "withClientId" : { "summary" : "ClientIdExample", "value" : { "emailAddress" : "0oa123456789", "role" : "read" } }, "withEmailAddress" : { "summary" : "EmailExample", "value" : { "emailAddress" : "user@guidewire.com", "role" : "read" } } }, "schema" : { "$ref" : "#/components/schemas/RoleMappingCreateRequest" } } } }, "ApplicationScopeRequest" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationScopeWrapper" } } } }, "BatchSettingValuesRequestWrapper" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchSettingValuesRequestWrapper" } } } }, "CloneSettingValuesRequest" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CloneSettingValuesRequest" } } } }, "BatchSettingValuesRequestV2Wrapper" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchSettingValuesRequestV2Wrapper" } } } }, "CloneSettingValuesRequestV2" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CloneSettingValuesRequestV2" } } } }, "DeploymentWrapper" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeploymentWrapper" } } } }, "SubscriptionRequestWrapper" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubscriptionRequestWrapper" } } } }, "SecretRotationWrapper" : { "content" : { "application/json" : { "examples" : { "SecretRotationExample" : { "value" : { "data" : { "applicationId" : 1451, "settingValueId" : 4321, "rotationReason" : "reason for rotation" } } } }, "schema" : { "$ref" : "#/components/schemas/SecretRotationWrapper" } } } }, "SecretRotationRequest" : { "content" : { "application/json" : { "examples" : { "SecretRotationExample" : { "value" : { "applicationId" : 1451, "settingValueId" : 4321, "rotationReason" : "reason for rotation" } } }, "schema" : { "$ref" : "#/components/schemas/SecretRotationRequest" } } } } }, "responses" : { "Conflict" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConflictError" } } }, "description" : "Conflict" }, "NotFound" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Not Found" }, "Forbidden" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationError" } } }, "description" : "Forbidden" }, "InternalError" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Internal Server Error" }, "BadRequest" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Error" } } }, "description" : "Bad Request" } }, "schemas" : { "id" : { "description" : "Surrogate key", "format" : "int64", "readOnly" : true, "type" : "integer" }, "version" : { "description" : "Used for optimistic locking. Only needed for updates. Expected to be the same as the value returned from the read.", "type" : "integer" }, "isTestData" : { "description" : "If true, this resource is used for testing and will be automatically purged.", "readOnly" : true, "type" : "boolean" }, "applicationId" : { "description" : "Identifies the application this entity is associated with.", "format" : "int64", "type" : "integer" }, "settingValueId" : { "description" : "Identifies the setting value this entity is associated with.", "format" : "int64", "type" : "integer" }, "operation" : { "enum" : [ "create", "update", "delete" ], "type" : "string" }, "deploymentId" : { "description" : "Identifies a deployment using GRN. See here for more information on [GRN](https://guidewireconfluence.atlassian.net/wiki/spaces/CCS/pages/92052971/GRN+-+Guidewire+Resource+Notation).", "pattern" : "^grn\\:v1\\:.*", "type" : "string" }, "SecretType" : { "description" : "Specifies the type of secret for this setting.

Current possible values are:

Additional secret types may be added in the future to support different rotation or management policies for secrets.", "type" : "string", "x-extensible-enum" : [ "GENERIC", "GW_OAUTH2_CLIENT_SECRET" ], "example" : null }, "ProviderContext" : { "additionalProperties" : { "type" : "string" }, "description" : "The provider context is a set of key-value pairs that provide necessary information for managing secrets of the GW_OAUTH2_CLIENT_SECRET type. ** Setting a provider context is disallowed on any other secret type other than GW_OAUTH2_CLIENT_SECRET. **\nFor `GW_OAUTH2_CLIENT_SECRET` **ONLY** the following fields are supported and required: - **providerId**: identifies which Guidewire Okta Hub is managing the secret. Accepted values are:\n - `guidewire-hub.oktapreview.com`\n - `guidewire-hub.okta.com`\n - `guidewire-hub-apac.okta.com`\n - `guidewire-hub-eu.okta.com`\n- **applicationId**: the Keti application ID of the application this secret is associated with.\n This is required for the Okta Hub to identify the correct client in Okta for secret management\n operations such as rotation.", "type" : "object" }, "ProviderReference" : { "additionalProperties" : { "type" : "string" }, "description" : "The provider reference is a key-value pair that provides necessary information for managing secrets of the GW_OAUTH2_CLIENT_SECRET type. **Setting a provider reference is disallowed on any other secret type other than GW_OAUTH2_CLIENT_SECRET, and can only be provided when a corresponding providerContext is provided.**\nFor `GW_OAUTH2_CLIENT_SECRET` **ONLY** the following fields are supported and required:\n - **id**: the Keti secret Id", "type" : "object" }, "SettingDefinitionSubscribedSetting" : { "description" : "The subscribed setting", "properties" : { "id" : { "description" : "Identifies subscribed setting definition", "format" : "int64", "readOnly" : true, "type" : "integer" }, "name" : { "description" : "The name of the subscribed setting definition", "readOnly" : true, "type" : "string" }, "createdBy" : { "description" : "The user that created subscription", "readOnly" : true, "type" : "string" }, "createdOn" : { "description" : "The date the subscription was created", "format" : "date-time", "readOnly" : true, "type" : "string" } }, "type" : "object" }, "SettingDefinitionPermittedSubscriber" : { "description" : "Properties for Permitted Subscriber", "properties" : { "applicationId" : { "$ref" : "#/components/schemas/applicationId" }, "applicationName" : { "description" : "Name of the application permitted to subscribe", "readOnly" : true, "type" : "string" }, "tenant" : { "description" : "Name of the tenant - customer developed applications only", "readOnly" : true, "type" : "string" }, "sharedBy" : { "description" : "The user that shared the setting", "readOnly" : true, "type" : "string" }, "sharedOn" : { "description" : "The date the setting was shared", "format" : "date-time", "readOnly" : true, "type" : "string" }, "subscribedSettings" : { "description" : "The subscribed settings", "items" : { "$ref" : "#/components/schemas/SettingDefinitionSubscribedSetting" }, "readOnly" : true, "type" : "array" } }, "type" : "object" }, "AuditInformation" : { "description" : "Common properties for all entities", "properties" : { "createdBy" : { "description" : "The user that created the tenant", "readOnly" : true, "type" : "string" }, "createdOn" : { "description" : "The date the tenant was created", "format" : "date-time", "readOnly" : true, "type" : "string" }, "modifiedBy" : { "description" : "The user that last modified the tenant", "readOnly" : true, "type" : "string" }, "modifiedOn" : { "description" : "The date the tenant was last modfied", "format" : "date-time", "readOnly" : true, "type" : "string" } }, "type" : "object" }, "TenancyType" : { "description" : "Describes the tenancy type of the application. This value can only be set when the application is initially created. It can not be changed later.\ntypes:\n * single: Single-tenant - Separate deployments of the application a requested for different tenants.\n * multi: Multi-tenant - Multiple tenants can share a single deployment of the application.\n * na: Not applicable - Used for applications that are virtual and do not have deployments (shared applications)\n\nNote: The default is `single` except for shared applications which defaults to `na`.", "enum" : [ "single", "na", "multi" ], "type" : "string" }, "applyOn" : { "description" : "The UTC date/time on which the change will be applied.", "format" : "date-time", "type" : "string" }, "AuthorizeClientResponse" : { "properties" : { "data" : { "$ref" : "#/components/schemas/AuthorizeClientResponse_data" } }, "type" : "object" }, "AuthorizeCustomerAccessResponse" : { "properties" : { "data" : { "$ref" : "#/components/schemas/AuthorizeCustomerAccessResponse_data" } }, "type" : "object" }, "Tenant" : { "allOf" : [ { "$ref" : "#/components/schemas/AuditInformation" } ], "description" : "A tenant is a moniker that provides the scope for data isolation", "properties" : { "id" : { "$ref" : "#/components/schemas/id" }, "version" : { "$ref" : "#/components/schemas/version" }, "name" : { "description" : "The name of the tenant.", "type" : "string" }, "isTestData" : { "$ref" : "#/components/schemas/isTestData" } }, "required" : [ "name" ], "type" : "object" }, "SettingValueWrapper" : { "description" : "Wrapper for SettingValue", "properties" : { "data" : { "$ref" : "#/components/schemas/SettingValue" } }, "required" : [ "data" ], "type" : "object" }, "ListWrapper" : { "description" : "Common properties in the list wrappers", "properties" : { "nextPageToken" : { "description" : "token to get next page results", "type" : "string", "example" : null } }, "type" : "object" }, "ListWrapperDeprecated" : { "description" : "Common properties in the list wrappers", "properties" : { "totalItems" : { "default" : 0, "deprecated" : true, "description" : "The number of items matching the specified criteria.", "format" : "int64", "readOnly" : true, "type" : "integer" }, "totalPages" : { "default" : 0, "deprecated" : true, "description" : "The number of pages of data that contain items matching the specified criteria.", "readOnly" : true, "type" : "integer" }, "nextPageOffset" : { "default" : 0, "deprecated" : true, "description" : "Value to pass into pageOffset to get the next page of items", "readOnly" : true, "type" : "integer" }, "previousPageOffset" : { "default" : 0, "deprecated" : true, "description" : "Value to pass into pageOffset to get the previous page of items", "readOnly" : true, "type" : "integer" }, "nextPageToken" : { "description" : "token to get next page results", "type" : "string" } }, "type" : "object" }, "SettingValueListWrapper" : { "allOf" : [ { "$ref" : "#/components/schemas/ListWrapper" }, { "properties" : { "data" : { "items" : { "$ref" : "#/components/schemas/SettingValue" }, "type" : "array" } }, "type" : "object" } ], "description" : "Wrapper for SettingValue List" }, "SettingValueBase" : { "description" : "Base fields (i.e. not audit) for a SettingValue", "properties" : { "id" : { "$ref" : "#/components/schemas/id" }, "version" : { "$ref" : "#/components/schemas/version" }, "applicationId" : { "$ref" : "#/components/schemas/applicationId" }, "name" : { "description" : "The name of the setting.", "example" : "setting.name", "maxLength" : 255, "minLength" : 3, "pattern" : "^(\\w|\\.|\\-)*$", "type" : "string" }, "value" : { "description" : "The value of the setting.", "maxLength" : 12288, "type" : "string" }, "comment" : { "description" : "Should be used to specify why the setting value is being changed, or additional information that will help understand the cause of the change. Could be very useful for troubleshooting changes that affect deployments.", "maxLength" : 1024, "type" : "string" }, "isTenantSpecific" : { "default" : true, "description" : "Indicates if the value is specific to the current tenant. This value should be set to false when creating a value to be used in the default (untenanted) configuration of a multi-tenant application. This value can only be set when the setting value is created .", "type" : "boolean" }, "applyTo" : { "$ref" : "#/components/schemas/SettingValueApplyTo" } }, "required" : [ "applicationId", "applyTo", "name", "value" ], "type" : "object" }, "SettingValue" : { "allOf" : [ { "$ref" : "#/components/schemas/SettingValueBase" }, { "$ref" : "#/components/schemas/AuditInformation" } ], "description" : "Contains the value for a given setting for a given application and deployment (environment or a layer of an environment)", "type" : "object" }, "SettingValueApplyTo" : { "description" : "Specifies to which layer setting is applied.", "discriminator" : { "mapping" : { "super_galaxy" : "#/components/schemas/ApplyToLayerSuperGalaxy", "tenant_default" : "#/components/schemas/ApplyToLayerTenant", "environment_level" : "#/components/schemas/ApplyToLayerEnvironmentLevel", "insurer_project" : "#/components/schemas/ApplyToLayerInsurerProjectLevel", "project_planet_class" : "#/components/schemas/ApplyToLayerProjectPlanetClass", "deployment" : "#/components/schemas/ApplyToLayerDeployment" }, "propertyName" : "layerType" }, "example" : { "layerType" : "deployment", "deploymentId" : "grn:v1:helios:::centaurus:local:local:bobsmith:/deployment/local" }, "properties" : { "layerType" : { "enum" : [ "deployment", "environment_level", "insurer_project", "project_planet_class", "tenant_default", "super_galaxy" ], "type" : "string" } }, "required" : [ "layerType" ], "type" : "object" }, "ApplyToLayerTenant" : { "allOf" : [ { "$ref" : "#/components/schemas/SettingValueApplyTo" } ], "description" : "Specifies setting applied to tenant layer." }, "ApplyToLayerInsurerProjectLevel" : { "allOf" : [ { "$ref" : "#/components/schemas/SettingValueApplyTo" }, { "properties" : { "insurerProject" : { "description" : "The logical project id for the setting value", "type" : "string" } }, "required" : [ "insurerProject" ], "type" : "object" } ], "description" : "Specifies setting applied to Insurer Project layer." }, "ApplyToLayerProjectPlanetClass" : { "allOf" : [ { "$ref" : "#/components/schemas/SettingValueApplyTo" }, { "properties" : { "insurerProject" : { "description" : "The logical project id to which the setting applies", "type" : "string" }, "planetClass" : { "description" : "Planet class to which the setting applies. This must be a valid planet class as per GRN specification.", "type" : "string" } }, "required" : [ "insurerProject", "planetClass" ], "type" : "object" } ], "description" : "Specifies setting applied to the combination of Insurer Project and Planet Class." }, "ApplyToLayerEnvironmentLevel" : { "allOf" : [ { "$ref" : "#/components/schemas/SettingValueApplyTo" }, { "properties" : { "environmentLevel" : { "description" : "Planet class to which the setting applies. This must be a valid planet class as per GRN specification.", "type" : "string" } }, "required" : [ "environmentLevel" ], "type" : "object" } ], "description" : "Specifies setting applied to Environment layer." }, "ApplyToLayerDeployment" : { "allOf" : [ { "$ref" : "#/components/schemas/SettingValueApplyTo" }, { "properties" : { "deployment" : { "deprecated" : true, "readOnly" : true, "type" : "string" }, "deploymentId" : { "description" : "A valid GRN that specifies a deployment.", "type" : "string" } }, "type" : "object" } ], "description" : "Specifies setting applied to Deployment layer." }, "ApplyToLayerSuperGalaxy" : { "allOf" : [ { "$ref" : "#/components/schemas/SettingValueApplyTo" }, { "properties" : { "superGalaxy" : { "description" : "Name of Super Galaxy. Must be a valid supergalaxy name or `internal`. The value `internal` can be used to represent Guidewire internal lower environments.", "enum" : [ "centaurus", "pandora", "copeland", "internal" ], "type" : "string" } }, "required" : [ "superGalaxy" ], "type" : "object" } ], "description" : "Specifies setting applied to Super Galaxy Layer" }, "BatchSettingValuesRequestWrapper" : { "description" : "Wrapper for BatchSettingValuesRequest", "properties" : { "data" : { "$ref" : "#/components/schemas/BatchSettingValuesRequest" } }, "required" : [ "data" ], "title" : "BatchSettingValuesRequestWrapper", "type" : "object" }, "BatchSettingValuesRequest" : { "description" : "A request payload that allows multiple setting values to be changes within an atomic transaction", "properties" : { "settingsValues" : { "default" : [ ], "items" : { "$ref" : "#/components/schemas/BatchSettingValueRequest" }, "type" : "array" } }, "required" : [ "settingsValues" ], "title" : "BatchSettingValuesRequest", "type" : "object" }, "BatchSettingValueRequest" : { "description" : "The operation to perform on a setting value within the batch request.", "properties" : { "operation" : { "enum" : [ "create", "update", "delete" ], "type" : "string" }, "applicationId" : { "$ref" : "#/components/schemas/applicationId" }, "name" : { "description" : "The name of the setting.", "example" : "setting.name", "pattern" : "^(\\w|\\.|\\-)*$", "type" : "string" }, "value" : { "description" : "The value of the setting. This field is required for create and update operations.", "type" : "string" }, "comment" : { "description" : "Should be used to specify why the setting value is being changed, or additional information that will help understand the cause of the change. Could be very useful for troubleshooting changes that affect deployments.", "maxLength" : 1024, "type" : "string" }, "version" : { "$ref" : "#/components/schemas/version" }, "applyTo" : { "$ref" : "#/components/schemas/SettingValueApplyTo" }, "isTenantSpecific" : { "default" : true, "description" : "Indicates if the value is specific to the current tenant. This value should be set to false when creating a value to be used in the default (untenanted) configuration of a multi-tenant application.", "type" : "boolean" } }, "required" : [ "applicationId", "applyTo", "name", "operation" ], "title" : "BatchSettingValueRequest", "type" : "object" }, "BatchSettingValuesResponseWrapper" : { "description" : "Wrapper for BatchSettingValuesResponseWrapper", "properties" : { "data" : { "$ref" : "#/components/schemas/BatchSettingValuesResponse" } }, "required" : [ "data" ], "title" : "BatchSettingValuesResponseWrapper", "type" : "object" }, "BatchSettingValuesResponse" : { "description" : "Response that details what setting values were updated in the atomic request", "properties" : { "created" : { "items" : { "$ref" : "#/components/schemas/SettingValue" }, "type" : "array" }, "updated" : { "items" : { "$ref" : "#/components/schemas/SettingValue" }, "type" : "array" }, "deleted" : { "items" : { "$ref" : "#/components/schemas/SettingValue" }, "type" : "array" } }, "title" : "BatchSettingValuesResponse", "type" : "object" }, "CloneSettingValuesRequest" : { "description" : "Clone setting values request", "properties" : { "source" : { "$ref" : "#/components/schemas/CloneSettingValuesSource" }, "destination" : { "$ref" : "#/components/schemas/CloneSettingValuesDestination" }, "comment" : { "description" : "When present, the comment is applied to each setting value written to the destination layer type / criteria.\nWhen not present, the comment associated with the source setting value (assuming a comment exists on the source) will be copied to the corresponding, destination setting value.\n", "type" : "string" }, "conflictResolutionStrategy" : { "default" : "fail_on_conflict", "description" : "A conflict occurs when a different setting value for given setting being cloned already exists for the given destination.\nWhen this occurs, the conflictResolutionStrategy tells Helios how to handle the conflict (i.e. return an error, skip / ignore, or override).\nIn the event that the source and destination values are equal there's no conflict, and Helios performs no action on the given setting.\n\nAllowed Values:\n* `fail_on_conflict` nothing gets copied and the request terminates with a 400 response whenever a conflict exists.\n* `skip_conflicts` clones only the setting values that do not already exist in the destination and skips any conflicts (maintaining any pre-existing setting values).\n* `override_conflicts` will clone all setting values to the destination by replacing any pre-existing setting values.\n", "enum" : [ "fail_on_conflict", "skip_conflicts", "override_conflicts" ], "type" : "string" } }, "required" : [ "applicationId", "destination", "source" ], "title" : "CloneSettingValuesRequest", "type" : "object" }, "CloneSettingValuesSource" : { "description" : "Identifies the setting values to be copied", "properties" : { "settingsToClone" : { "items" : { "$ref" : "#/components/schemas/id" }, "type" : "array" } }, "type" : "object" }, "CloneSettingValuesDestination" : { "description" : "Identifies where the setting values are to be copied", "properties" : { "applyTo" : { "$ref" : "#/components/schemas/SettingValueApplyTo" } }, "required" : [ "applyTo" ], "type" : "object" }, "CloneSettingValuesResponse" : { "description" : "Returns the cloning results", "properties" : { "created" : { "description" : "Lists any newly created SettingValues as a result of the cloning. Represents setting values that did not previously exist in the destination.", "items" : { "$ref" : "#/components/schemas/SettingValue" }, "type" : "array" }, "updated" : { "description" : "Lists any replaced or overwritten SettingValues as a result of the cloning. Only applicable to conflict resolution strategy: `override_conflicts`", "items" : { "$ref" : "#/components/schemas/SettingValue" }, "type" : "array" }, "skipped" : { "description" : "Lists SettingValues that could not be cloned due to a conflict. Only applicable to conflict resolution strategy: `skip_conflicts`", "items" : { "$ref" : "#/components/schemas/SettingValue" }, "type" : "array" } }, "required" : [ "created", "skipped", "updated" ], "title" : "CloneSettingValuesResponse", "type" : "object" }, "HistoryQueryResponseWrapper" : { "allOf" : [ { "$ref" : "#/components/schemas/ListWrapper" }, { "properties" : { "data" : { "items" : { "$ref" : "#/components/schemas/HistoryQueryResponse" }, "type" : "array" } }, "required" : [ "data" ], "type" : "object" } ], "description" : "Wrapper for HistoryQueryResponseWrapper", "title" : "HistoryQueryResponseWrapper", "type" : "object" }, "HistoryQueryResponse" : { "description" : "Response that details the history of a setting", "properties" : { "operation" : { "$ref" : "#/components/schemas/operation" }, "startDate" : { "format" : "date-time", "type" : "string" }, "endDate" : { "format" : "date-time", "type" : "string" }, "settingValue" : { "$ref" : "#/components/schemas/SettingValue" } }, "required" : [ "settingValue", "startDate" ], "title" : "HistoryQueryResponse", "type" : "object" }, "SettingDefinitionHistoryQueryResponse" : { "allOf" : [ { "$ref" : "#/components/schemas/ListWrapperDeprecated" }, { "properties" : { "data" : { "items" : { "$ref" : "#/components/schemas/SettingDefinitionHistoryQueryResponseItem" }, "type" : "array" } }, "required" : [ "data" ], "type" : "object" } ], "description" : "Root response for setting value audit records across layers.", "title" : "SettingDefinitionHistoryQueryResponse", "type" : "object" }, "SettingDefinitionHistoryQueryResponseItem" : { "description" : "An audit record for a setting value corresponding to the cross layer query.", "properties" : { "operation" : { "$ref" : "#/components/schemas/operation" }, "who" : { "type" : "string" }, "when" : { "format" : "date-time", "type" : "string" }, "settingValue" : { "$ref" : "#/components/schemas/SettingValueBase" } }, "required" : [ "operation", "settingValue", "when", "who" ], "title" : "SettingDefinitionHistoryQueryResponseItem", "type" : "object" }, "SettingValueListV2Wrapper" : { "allOf" : [ { "$ref" : "#/components/schemas/ListWrapper" }, { "properties" : { "data" : { "items" : { "$ref" : "#/components/schemas/SettingValueV2" }, "type" : "array" } }, "type" : "object" } ], "description" : "Wrapper for SettingValue List" }, "SettingValueBaseV2" : { "description" : "Base fields (i.e. not audit) for a SettingValue", "properties" : { "id" : { "$ref" : "#/components/schemas/id" }, "version" : { "$ref" : "#/components/schemas/version" }, "applicationId" : { "$ref" : "#/components/schemas/applicationId" }, "name" : { "description" : "The name of the setting.", "example" : "setting.name", "maxLength" : 255, "minLength" : 3, "pattern" : "^(\\w|\\.|\\-)*$", "type" : "string" }, "value" : { "description" : "The value of the setting.", "maxLength" : 12288, "type" : "string" }, "comment" : { "description" : "Should be used to specify why the setting value is being changed, or additional information that will help understand the cause of the change. Could be very useful for troubleshooting changes that affect deployments.", "maxLength" : 1024, "type" : "string" }, "isTenantSpecific" : { "default" : true, "description" : "Indicates if the value is specific to the current tenant. This value should be set to false when creating a value to be used in the default (untenanted) configuration of a multi-tenant application. This value can only be set when the setting value is created .", "type" : "boolean" }, "applyTo" : { "$ref" : "#/components/schemas/SettingValueApplyToV2" }, "secretDetails" : { "$ref" : "#/components/schemas/SecretDetailsV2" } }, "required" : [ "applicationId", "applyTo", "name", "value" ], "type" : "object" }, "SettingValueV2" : { "allOf" : [ { "$ref" : "#/components/schemas/SettingValueBaseV2" }, { "$ref" : "#/components/schemas/AuditInformation" } ], "description" : "Contains the value for a given setting for a given application and deployment (environment or a layer of an environment)", "type" : "object" }, "SettingValueV2Wrapper" : { "description" : "Wrapper for SettingValueV2", "properties" : { "data" : { "$ref" : "#/components/schemas/SettingValueV2" } }, "required" : [ "data" ], "type" : "object" }, "SecretDetailsV2" : { "description" : "Provides metadata for a secret setting value, including the type of secret represented by this setting value. This object is present only for a setting whose values are stored as a secret.", "properties" : { "secretType" : { "$ref" : "#/components/schemas/SecretType" }, "providerContext" : { "$ref" : "#/components/schemas/ProviderContext" }, "providerReference" : { "$ref" : "#/components/schemas/ProviderReference" } }, "required" : [ "secretType" ], "type" : "object" }, "SettingValueApplyToV2" : { "description" : "Specifies to which layer setting is applied.", "discriminator" : { "mapping" : { "isolation_zone" : "#/components/schemas/ApplyToLayerIsolationZoneV2", "tenant_default" : "#/components/schemas/ApplyToLayerTenantV2", "star" : "#/components/schemas/ApplyToLayerStarV2", "orbit" : "#/components/schemas/ApplyToLayerOrbitV2", "star_orbit" : "#/components/schemas/ApplyToLayerStarOrbitV2", "deployment" : "#/components/schemas/ApplyToLayerDeploymentV2", "planet" : "#/components/schemas/ApplyToLayerPlanetV2" }, "propertyName" : "layerType" }, "example" : { "layerType" : "deployment", "deploymentId" : "grn:v1:helios:::amer-0:local:local:bobsmith:/deployment/andromeda" }, "properties" : { "layerType" : { "type" : "string", "x-extensible-enum" : [ "isolation_zone", "tenant_default", "star", "orbit", "star_orbit", "planet", "deployment" ] } }, "required" : [ "layerType" ], "type" : "object" }, "ApplyToLayerTenantV2" : { "allOf" : [ { "$ref" : "#/components/schemas/SettingValueApplyToV2" } ], "description" : "Specifies setting applied to Tenant layer." }, "ApplyToLayerStarV2" : { "allOf" : [ { "$ref" : "#/components/schemas/SettingValueApplyToV2" }, { "properties" : { "star" : { "description" : "The logical star id for the setting value", "type" : "string" } }, "required" : [ "star" ], "type" : "object" } ], "description" : "Specifies setting applied to Star layer." }, "ApplyToLayerStarOrbitV2" : { "allOf" : [ { "$ref" : "#/components/schemas/SettingValueApplyToV2" }, { "properties" : { "star" : { "description" : "The logical star id for the setting value", "type" : "string" }, "orbit" : { "description" : "Orbit to which the setting applies. This must be a valid planet class as per GRN specification.", "type" : "string" } }, "required" : [ "orbit", "star" ], "type" : "object" } ], "description" : "Specifies setting applied to the combination of Star and Orbit." }, "ApplyToLayerOrbitV2" : { "allOf" : [ { "$ref" : "#/components/schemas/SettingValueApplyToV2" }, { "properties" : { "orbit" : { "description" : "The Orbit to which the setting applies. This must be a valid planet class as per GRN specification.", "type" : "string" } }, "required" : [ "orbit" ], "type" : "object" } ], "description" : "Specifies setting applied to Orbit layer." }, "ApplyToLayerDeploymentV2" : { "allOf" : [ { "$ref" : "#/components/schemas/SettingValueApplyToV2" }, { "properties" : { "deploymentId" : { "description" : "A valid GRN that specifies a deployment.", "type" : "string" } }, "type" : "object" } ], "description" : "Specifies setting applied to Deployment layer." }, "ApplyToLayerPlanetV2" : { "allOf" : [ { "$ref" : "#/components/schemas/SettingValueApplyToV2" }, { "properties" : { "deploymentId" : { "description" : "A valid GRN that identifies a deployment. Helios will extract/normalize Isolation-Zone, Star and Planet information from the given GRN and only use the Isolation-Zone, Star and Planet information when determining the effective-configuration for a given deployment. This field is required in order to provide backwards-compatibility with /v1/setting-values by allowing \"Planet\" setting-values to be translated to \"Deployment\" setting-values in /v1/setting-values. Once /v1/setting-values has been sunsetting this field will become optional (allowing one to supply just the Isolation Zone, Star and Planet in the future). Please note that this field is NOT required in responses. While this field will initially be present in all responses one should not expect this field to always be present as the field is intended to be deprecated and made optional after /v1/setting-values is removed.", "type" : "string" }, "isolationZone" : { "description" : "Isolation Zone Id. Must be a valid isolation zone id.", "type" : "string" }, "star" : { "description" : "The logical star id for the setting value", "type" : "string" }, "planet" : { "description" : "The Planet to which the setting applies.", "type" : "string" } }, "type" : "object" } ], "description" : "Specifies setting applied to Planet layer." }, "ApplyToLayerIsolationZoneV2" : { "allOf" : [ { "$ref" : "#/components/schemas/SettingValueApplyToV2" }, { "properties" : { "isolationZone" : { "description" : "Isolation Zone Id. Must be a valid isolation zone id.", "type" : "string" } }, "required" : [ "isolationZone" ], "type" : "object" } ], "description" : "Specifies setting applied to Isolation Zone Layer" }, "BatchSettingValuesRequestV2Wrapper" : { "description" : "Wrapper for BatchSettingValuesRequestV2", "properties" : { "data" : { "$ref" : "#/components/schemas/BatchSettingValuesRequestV2" } }, "required" : [ "data" ], "type" : "object" }, "BatchSettingValuesRequestV2" : { "description" : "A request payload that allows multiple setting values to be changes within an atomic transaction", "properties" : { "settingsValues" : { "default" : [ ], "items" : { "$ref" : "#/components/schemas/BatchSettingValueRequestV2" }, "type" : "array" } }, "required" : [ "settingsValues" ], "type" : "object" }, "BatchSettingValueRequestV2" : { "description" : "The operation to perform on a setting value within the batch request.", "properties" : { "operation" : { "enum" : [ "create", "update", "delete" ], "type" : "string" }, "applicationId" : { "$ref" : "#/components/schemas/applicationId" }, "name" : { "description" : "The name of the setting.", "example" : "setting.name", "pattern" : "^(\\w|\\.|\\-)*$", "type" : "string" }, "value" : { "description" : "The value of the setting. This field is required for create and update operations.", "type" : "string" }, "comment" : { "description" : "Should be used to specify why the setting value is being changed, or additional information that will help understand the cause of the change. Could be very useful for troubleshooting changes that affect deployments.", "maxLength" : 1024, "type" : "string" }, "version" : { "$ref" : "#/components/schemas/version" }, "applyTo" : { "$ref" : "#/components/schemas/SettingValueApplyToV2" }, "isTenantSpecific" : { "default" : true, "description" : "Indicates if the value is specific to the current tenant. This value should be set to false when creating a value to be used in the default (untenanted) configuration of a multi-tenant application.", "type" : "boolean" } }, "required" : [ "applicationId", "applyTo", "name", "operation" ], "type" : "object" }, "BatchSettingValuesResponseV2Wrapper" : { "description" : "Wrapper for BatchSettingValuesResponseV2", "properties" : { "data" : { "$ref" : "#/components/schemas/BatchSettingValuesResponseV2" } }, "required" : [ "data" ], "type" : "object" }, "BatchSettingValuesResponseV2" : { "description" : "Response that details what setting values were updated in the atomic request", "properties" : { "created" : { "items" : { "$ref" : "#/components/schemas/SettingValueV2" }, "type" : "array" }, "updated" : { "items" : { "$ref" : "#/components/schemas/SettingValueV2" }, "type" : "array" }, "deleted" : { "items" : { "$ref" : "#/components/schemas/SettingValueV2" }, "type" : "array" } }, "type" : "object" }, "CloneSettingValuesRequestV2" : { "description" : "Clone setting values request", "properties" : { "source" : { "$ref" : "#/components/schemas/CloneSettingValuesSourceV2" }, "destination" : { "$ref" : "#/components/schemas/CloneSettingValuesDestinationV2" }, "comment" : { "description" : "When present, the comment is applied to each setting value written to the destination layer type / criteria.\nWhen not present, the comment associated with the source setting value (assuming a comment exists on the source) will be copied to the corresponding, destination setting value.\n", "type" : "string" }, "conflictResolutionStrategy" : { "default" : "fail_on_conflict", "description" : "A conflict occurs when a different setting value for given setting being cloned already exists for the given destination.\nWhen this occurs, the conflictResolutionStrategy tells Helios how to handle the conflict (i.e. return an error, skip / ignore, or override).\nIn the event that the source and destination values are equal there's no conflict, and Helios performs no action on the given setting.\n\nAllowed Values:\n* `fail_on_conflict` nothing gets copied and the request terminates with a 400 response whenever a conflict exists.\n* `skip_conflicts` clones only the setting values that do not already exist in the destination and skips any conflicts (maintaining any pre-existing setting values).\n* `override_conflicts` will clone all setting values to the destination by replacing any pre-existing setting values.\n", "enum" : [ "fail_on_conflict", "skip_conflicts", "override_conflicts" ], "type" : "string", "x-enumNames" : [ "fail_on_conflict", "skip_conflicts", "override_conflicts" ] } }, "required" : [ "applicationId", "destination", "source" ], "type" : "object" }, "CloneSettingValuesSourceV2" : { "description" : "Identifies the setting values to be copied", "properties" : { "settingsToClone" : { "items" : { "$ref" : "#/components/schemas/id" }, "type" : "array" } }, "type" : "object" }, "CloneSettingValuesDestinationV2" : { "description" : "Identifies where the setting values are to be copied", "properties" : { "applyTo" : { "$ref" : "#/components/schemas/SettingValueApplyToV2" } }, "required" : [ "applyTo" ], "type" : "object" }, "CloneSettingValuesResponseV2" : { "description" : "Returns the cloning results", "properties" : { "created" : { "description" : "Lists any newly created SettingValues as a result of the cloning. Represents setting values that did not previously exist in the destination.", "items" : { "$ref" : "#/components/schemas/SettingValueV2" }, "type" : "array" }, "updated" : { "description" : "Lists any replaced or overwritten SettingValues as a result of the cloning. Only applicable to conflict resolution strategy: `override_conflicts`", "items" : { "$ref" : "#/components/schemas/SettingValueV2" }, "type" : "array" }, "skipped" : { "description" : "Lists SettingValues that could not be cloned due to a conflict. Only applicable to conflict resolution strategy: `skip_conflicts`", "items" : { "$ref" : "#/components/schemas/SettingValueV2" }, "type" : "array" } }, "required" : [ "created", "skipped", "updated" ], "type" : "object" }, "HistoryQueryResponseV2Wrapper" : { "allOf" : [ { "$ref" : "#/components/schemas/ListWrapper" }, { "properties" : { "data" : { "items" : { "$ref" : "#/components/schemas/HistoryQueryResponseV2" }, "type" : "array" } }, "required" : [ "data" ], "type" : "object" } ], "description" : "Wrapper for HistoryQueryResponseWrapper", "type" : "object" }, "HistoryQueryResponseV2" : { "description" : "Response that details the history of a setting", "properties" : { "operation" : { "$ref" : "#/components/schemas/operation" }, "startDate" : { "format" : "date-time", "type" : "string" }, "endDate" : { "format" : "date-time", "type" : "string" }, "settingValue" : { "$ref" : "#/components/schemas/SettingValueV2" } }, "required" : [ "settingValue", "startDate" ], "type" : "object" }, "Environment" : { "properties" : { "label" : { "default" : "master", "readOnly" : true, "type" : "string" }, "name" : { "type" : "string" }, "profiles" : { "items" : { "type" : "string" }, "type" : "array" }, "propertySources" : { "items" : { "$ref" : "#/components/schemas/PropertySource" }, "type" : "array" }, "state" : { "type" : "string" }, "version" : { "type" : "string" } }, "title" : "Environment", "type" : "object" }, "PropertySource" : { "properties" : { "name" : { "type" : "string" }, "source" : { "properties" : { }, "type" : "object" } }, "title" : "PropertySource", "type" : "object" }, "EffectiveConfigResponseWrapper" : { "description" : "Wrapper for client effective configuration response", "properties" : { "data" : { "$ref" : "#/components/schemas/EffectiveConfigResponse" } }, "required" : [ "data" ], "title" : "EffectiveConfigResponseWrapper", "type" : "object" }, "EffectiveConfigResponse" : { "properties" : { "effectiveConfiguration" : { "description" : "Effective settings requested by the client.", "items" : { "$ref" : "#/components/schemas/EffectiveConfigValueItem" }, "type" : "array" } } }, "EffectiveConfigCompositeResponseWrapper" : { "description" : "Wrapper for client effective configuration response that includes request level layers/overrides", "properties" : { "data" : { "$ref" : "#/components/schemas/EffectiveConfigCompositeResponse" } }, "required" : [ "data" ], "title" : "EffectiveConfigCompositeResponseWrapper", "type" : "object" }, "EffectiveConfigCompositeResponse" : { "allOf" : [ { "$ref" : "#/components/schemas/EffectiveConfigResponse" } ], "properties" : { "tenantedConfiguration" : { "items" : { "$ref" : "#/components/schemas/TenantedConfigResponseItem" }, "type" : "array" } } }, "TenantedConfigResponseItem" : { "description" : "effective settings for a tenant override. This will be used by the client to override effective configuration for requests into the service containing the client.", "properties" : { "settingName" : { "description" : "Name of the setting", "type" : "string" }, "settingValue" : { "description" : "Current value of the setting", "type" : "string" }, "grnMatcher" : { "description" : "GRN pattern with wildcards that may match the provided deployment id.", "type" : "string" }, "priorityOrder" : { "default" : 0, "description" : "An integer representing the priority order / precendence of layer values with 1 being the highest precendence.", "type" : "integer" } } }, "EffectiveConfigValueItem" : { "description" : "Contains setting name and current setting value", "properties" : { "settingName" : { "description" : "Name of the setting", "type" : "string" }, "settingValue" : { "description" : "Current value of the setting", "type" : "string" }, "meta" : { "$ref" : "#/components/schemas/EffectiveConfigValueItemMeta" } }, "required" : [ "settingName", "settingValue" ], "type" : "object" }, "EffectiveConfigValueItemMeta" : { "description" : "Contains metadata about the value", "properties" : { "settingId" : { "description" : "Identifies the setting value where the value was retrieved", "format" : "int64", "readOnly" : true, "type" : "integer" }, "isSecret" : { "description" : "Indicates if the setting values contain secrets.", "readOnly" : true, "type" : "boolean" }, "messages" : { "items" : { "$ref" : "#/components/schemas/EffectiveConfigValueItemMetaMessage" }, "type" : "array" }, "applyTo" : { "$ref" : "#/components/schemas/SettingValueApplyTo" }, "unusedSettings" : { "items" : { "$ref" : "#/components/schemas/EffectiveConfigValueItem" }, "type" : "array" }, "audit" : { "$ref" : "#/components/schemas/AuditInformation" } }, "type" : "object" }, "EffectiveConfigValueItemMetaMessage" : { "description" : "Contains messages about the effective configuration", "properties" : { "priority" : { "description" : "The priority of the message", "readOnly" : true, "type" : "string" }, "message" : { "description" : "The message about the configuration", "readOnly" : true, "type" : "string" } }, "type" : "object" }, "Application" : { "allOf" : [ { "$ref" : "#/components/schemas/AuditInformation" } ], "description" : "An application in Helios represents a real application that is configured through Helios.", "properties" : { "id" : { "$ref" : "#/components/schemas/id" }, "version" : { "$ref" : "#/components/schemas/version" }, "name" : { "description" : "Name used to identify the application. This must be an exact match to the application name configured in the deployment id of the application. Note: The requirement for the name to match the deployent id does not apply to shared applications.", "example" : "exampleapp", "maxLength" : 255, "minLength" : 2, "pattern" : "^(\\w|\\.|\\-)*$", "type" : "string" }, "displayName" : { "description" : "Displayable name for the application. Defaults to the value in the name field. Accepts Foreign Languages, such as: Arabic, Chinese, Kanji, ... May be null but does not accept an empty string or all whitespace", "example" : "Example Application", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\s]+.*$", "type" : "string" }, "owner" : { "description" : "The person or group that owns the application. This information is only used as contact information. It has no impact on security.", "maxLength" : 255, "minLength" : 3, "type" : "string" }, "ownerEmail" : { "description" : "Email address for the owner of the application. This information is only used as contact information. It has no impact on security.", "format" : "email", "maxLength" : 255, "type" : "string" }, "isPublic" : { "default" : false, "description" : "Indicates that the application is a public application (SPA) and does not require authentication. This type of application is not allowed to store secrets.", "type" : "boolean" }, "isTestData" : { "$ref" : "#/components/schemas/isTestData" }, "isCustomerDeveloped" : { "default" : false, "description" : "Indicates if the application is developed exclusively by a customer. \nWhen set to true, the application and all associated metadata is specific to a single tenant. \nThis attribute may only be set when the application is initially created.\n\nNote: Customer developed application names are required to start with one of the following prefixes: \n* 'bf' - BusinessFunctions applications\n* 'ee' - EnterpriseEngage applications\n* 'ig' - IntegrationGateway applications\n", "type" : "boolean" }, "isShared" : { "default" : false, "description" : "Indicates that the application is responsible for publishing shared settings. Only applications with this flag enabled are permitted to share setting values with other applications. This attribute may only be set when the application is initially created.", "type" : "boolean" }, "tenancyType" : { "$ref" : "#/components/schemas/TenancyType" }, "groupId" : { "description" : "id of the application group", "type" : "string" } }, "required" : [ "name", "owner", "ownerEmail" ], "type" : "object" }, "AuthorizeClientRequestWrapper" : { "description" : "Wrapper for AuthorizeClientRequest", "properties" : { "data" : { "$ref" : "#/components/schemas/AuthorizeClientRequest" } }, "required" : [ "data" ], "title" : "AuthorizeClientRequestWrapper", "type" : "object" }, "AuthorizeCustomerAccessV2RequestWrapper" : { "description" : "Wrapper for AuthorizeCustomerAccessV2Request", "properties" : { "data" : { "$ref" : "#/components/schemas/AuthorizeCustomerAccessV2Request" } }, "required" : [ "data" ], "title" : "AuthorizeCustomerAccessRequestV2Wrapper", "type" : "object" }, "AuthorizeCustomerAccessV2Request" : { "example" : { "gwHubInstance" : "staging", "applicationGroup" : "ig", "role" : "user" }, "properties" : { "gwHubInstance" : { "$ref" : "#/components/schemas/GwHubInstance" }, "applicationGroup" : { "deprecated" : true, "description" : "Identifies the group of applications. \n\nAllowed application groups:\n* 'ig' - IntegrationGateway applications (customer-developed)\n\nDeprecated on 2024-02-26 - use applicationGroupExtensible instead.\n", "enum" : [ "ig" ], "type" : "string" }, "applicationGroupExtensible" : { "description" : "Identifies the group of applications. \n\nAllowed application groups:\n* 'bf' - BusinessFunctions applications (customer-developed)\n* 'ee' - EnterpriseEngage applications (customer-developed)\n* 'ig' - IntegrationGateway applications (customer-developed)\n* 'is' - InsuranceSuite applications (bc, cc, cm, pc)\n", "type" : "string", "x-extensible-enum" : [ "bf", "ee", "ig", "is" ] }, "role" : { "description" : "For integration gateway applications, a single role named __user__ will be available.\nThe __user__ role will grant read access to all setting definitions, setting values and application records within the application group based on tenant access.\n", "enum" : [ "user" ], "type" : "string" } }, "required" : [ "gwHubInstance", "role" ], "type" : "object" }, "AuthorizeCustomerClientAccessRequestWrapper" : { "description" : "Wrapper for AuthorizeCustomerClientAccessRequest", "properties" : { "data" : { "$ref" : "#/components/schemas/AuthorizeCustomerClientAccessRequest" } }, "required" : [ "data" ], "title" : "AuthorizeCustomerClientAccessRequestWrapper", "type" : "object" }, "AuthorizeCustomerClientAccessRequest" : { "example" : { "gwHubInstance" : "staging", "clientId" : "khJk9BsxLG8oXX2", "role" : "guidewire.lower.gwcp.all.helios.ig-user" }, "properties" : { "gwHubInstance" : { "$ref" : "#/components/schemas/GwHubInstance" }, "role" : { "description" : "the full role you are requesting in the following format: ...all.helios.ig-user\n", "type" : "string" }, "clientId" : { "description" : "Client ID from keti registration.", "minLength" : 1, "nullable" : false, "type" : "string" } }, "required" : [ "clientId", "gwHubInstance", "role" ], "type" : "object" }, "AuthorizeClientRequest" : { "properties" : { "clientId" : { "description" : "Client ID from keti registration.", "minLength" : 1, "nullable" : false, "type" : "string" }, "gwHubInstance" : { "$ref" : "#/components/schemas/GwHubInstance" } }, "required" : [ "clientId", "gwHubInstance" ], "type" : "object" }, "GwHubInstance" : { "description" : "Name of the GW Hub instance where the client is registered.", "enum" : [ "staging", "centaurus", "copeland", "pandora" ], "type" : "string" }, "SettingDefinitionResponseListWrapper" : { "allOf" : [ { "$ref" : "#/components/schemas/ListWrapper" }, { "properties" : { "data" : { "items" : { "$ref" : "#/components/schemas/SettingDefinitionResponse" }, "type" : "array" } }, "required" : [ "data" ], "type" : "object" } ], "description" : "Wrapper for SettingDefinition List Response", "title" : "SettingDefinitionResponseListWrapper", "type" : "object" }, "SettingDefinitionResponseWrapper" : { "description" : "Wrapper for SettingDefinitionResponse", "properties" : { "data" : { "$ref" : "#/components/schemas/SettingDefinitionResponse" } }, "required" : [ "data" ], "title" : "SettingDefinitionResponseWrapper", "type" : "object" }, "SettingDefinitionResponse" : { "allOf" : [ { "$ref" : "#/components/schemas/SettingDefinition" }, { "$ref" : "#/components/schemas/AuditInformation" } ], "description" : "Describes a setting for a given application.", "properties" : { "id" : { "$ref" : "#/components/schemas/id" }, "version" : { "$ref" : "#/components/schemas/version" } }, "required" : [ "settingName" ], "type" : "object" }, "SettingDefinitionRequestWrapper" : { "allOf" : [ { "$ref" : "#/components/schemas/ListWrapper" }, { "properties" : { "data" : { "$ref" : "#/components/schemas/SettingDefinitionRequest" } }, "required" : [ "data" ], "type" : "object" } ], "description" : "Wrapper for SettingDefinitionRequest", "title" : "SettingDefinitionRequestWrapper", "type" : "object" }, "SettingDefinitionRequest" : { "allOf" : [ { "$ref" : "#/components/schemas/SettingDefinition" } ], "properties" : { "version" : { "$ref" : "#/components/schemas/version" } }, "type" : "object" }, "SettingDefinition" : { "properties" : { "settingName" : { "description" : "Name of the setting this definition is associated with", "example" : "setting.name", "pattern" : "^(\\w|\\.|\\-)*$", "type" : "string" }, "isSecret" : { "default" : false, "description" : "If true, the associated setting is considered a secret. Defaults to 'true' when a `SecretType` is provided. When `isSecret` is explicitly set to `true` and `secretType` is not provided, the `secretType` will default to 'GENERIC'. If `secretType` is explicitly specified, it will take precedence over this default behavior.

Update restrictions apply to this field:

", "type" : "boolean" }, "secretType" : { "$ref" : "#/components/schemas/SecretType" }, "insurerProject" : { "description" : "When this attribute is provided, a project-specific setting definition will be created for the tenant specified in the GW-Request-GRN header.

Note : This attribute may only be set on create request.", "maxLength" : 10, "pattern" : "^[A-Za-z0-9]*$", "type" : "string", "example" : null }, "settingDescription" : { "description" : "A description of the setting that this definition is associated with", "type" : "string", "example" : null }, "isTenantSpecific" : { "default" : false, "description" : "Whether this setting is present only for the current tenant, i.e. hidden from other tenants.", "readOnly" : true, "type" : "boolean" }, "isGuidewireManaged" : { "default" : false, "description" : "When set to true, corresponding setting value(s) can only be maintained by Guidewire.\n\nCannot create a definition as guidewire-managed when a less specific definition (one sharing the same application and setting name) already exists. \nCannot change a definition to guidewire-managed when a more specific definition (one sharing the same application and setting name) already exists.\n", "type" : "boolean" }, "associatedTenants" : { "description" : "Shows all associated tenants having a setting value associated to this definition.

", "items" : { "type" : "string" }, "type" : "array", "example" : null }, "permittedSubscribers" : { "description" : "List of applications permitted to subscribe to this setting", "items" : { "$ref" : "#/components/schemas/SettingDefinitionPermittedSubscriber" }, "type" : "array", "example" : null }, "publisher" : { "$ref" : "#/components/schemas/SettingDefinition_publisher" } }, "required" : [ "settingName" ], "type" : "object" }, "SettingDefinitionShareRequestWrapper" : { "properties" : { "data" : { "$ref" : "#/components/schemas/SettingDefinitionShareRequest" } }, "required" : [ "data" ], "type" : "object" }, "SettingDefinitionShareRequest" : { "properties" : { "shareWithApplicationId" : { "$ref" : "#/components/schemas/applicationId" } }, "required" : [ "shareWithApplicationId" ], "type" : "object" }, "Role" : { "allOf" : [ { "$ref" : "#/components/schemas/AuditInformation" } ], "properties" : { "id" : { "$ref" : "#/components/schemas/id" }, "version" : { "$ref" : "#/components/schemas/version" }, "name" : { "description" : "The name used to identify the role.", "type" : "string" }, "description" : { "description" : "Description of the role.", "type" : "string" }, "applicationId" : { "description" : "The application to which the role applies", "format" : "int64", "type" : "integer" } }, "required" : [ "description", "name" ], "type" : "object" }, "RoleMapping" : { "allOf" : [ { "$ref" : "#/components/schemas/AuditInformation" } ], "description" : "Used to map a user identifier (email) or group identifier (group name) from the IdP to roles defined in the property service configuration.", "properties" : { "id" : { "$ref" : "#/components/schemas/id" }, "roleId" : { "description" : "Identifies the role", "format" : "int64", "type" : "integer" }, "version" : { "$ref" : "#/components/schemas/version" }, "emailAddress" : { "description" : "The email address of the user assigned to the given role.", "type" : "string" }, "groupName" : { "description" : "The name of the group assigned to the given role.", "type" : "string" }, "isTenantSpecific" : { "default" : false, "description" : "Indicates if the role mapping is specific to the current tenant.", "readOnly" : true, "type" : "boolean" } }, "type" : "object" }, "RoleMappingView" : { "allOf" : [ { "$ref" : "#/components/schemas/AuditInformation" } ], "description" : "Maps a role to a user or group (mutually exclusive).", "properties" : { "id" : { "$ref" : "#/components/schemas/id" }, "version" : { "$ref" : "#/components/schemas/version" }, "emailAddress" : { "description" : "The email address of the user", "type" : "string" }, "groupName" : { "description" : "The name of the group", "type" : "string" }, "role" : { "description" : "The name of the role granted to the user or group", "type" : "string" }, "applicationId" : { "$ref" : "#/components/schemas/applicationId" }, "applicationGroup" : { "description" : "The name of the application group this role was granted for", "type" : "string" }, "isTenantSpecific" : { "default" : false, "description" : "Indicates if the role mapping is specific to the current tenant.", "readOnly" : true, "type" : "boolean" } }, "type" : "object" }, "ApplicationScopeWrapper" : { "properties" : { "data" : { "$ref" : "#/components/schemas/ApplicationScope" } }, "required" : [ "data" ], "type" : "object" }, "ApplicationScope" : { "allOf" : [ { "$ref" : "#/components/schemas/AuditInformation" } ], "description" : "Maps an application role to a scope", "properties" : { "id" : { "$ref" : "#/components/schemas/id" }, "version" : { "$ref" : "#/components/schemas/version" }, "clientId" : { "description" : "Client ID from keti registration.", "minLength" : 1, "nullable" : false, "type" : "string" }, "gwHubInstance" : { "$ref" : "#/components/schemas/GwHubInstance" }, "roleName" : { "description" : "Name of the role to grant. This will be used to generate the scope name,

Valid values: read, write, write-nonprod, definition-mgr, owner", "type" : "string" }, "scopeName" : { "description" : "Full scope name", "readOnly" : true, "type" : "string" } }, "required" : [ "clientId", "gwHubInstance", "roleName" ], "type" : "object" }, "RoleMappingCreateRequest" : { "description" : "Used to map a user to a role.EmailAddress and groupName are mutually exclusive.", "properties" : { "emailAddress" : { "description" : "The email address of the user assigned to the given role.", "type" : "string" }, "groupName" : { "description" : "The group assigned to the given role.", "type" : "string" }, "role" : { "description" : "The role to give the user. Currently supports the values read, write, owner, write-nonprod and definition-mgr.", "type" : "string" } }, "required" : [ "role" ], "type" : "object" }, "IdpListItem" : { "description" : "Contains information about an IdP in which groups for the application are whitelisted .", "properties" : { "idpId" : { "description" : "IdP ID registered in gwhub instance.", "type" : "string" }, "idpName" : { "description" : "Name of the IdP", "type" : "string" } }, "type" : "object" }, "Error" : { "properties" : { "entityName" : { "description" : "Name of the setting or application", "type" : "string" }, "errorKey" : { "description" : "Error key", "type" : "string" }, "type" : { "description" : "Type of error", "type" : "string" }, "title" : { "description" : "Title of error", "type" : "string" }, "status" : { "description" : "Status", "type" : "string" }, "message" : { "description" : "Error message", "type" : "string" }, "params" : { "description" : "Parameter", "type" : "string" }, "violations" : { "items" : { "$ref" : "#/components/schemas/ErrorViolation" }, "type" : "array" } }, "required" : [ "entityName", "errorKey", "status" ], "type" : "object" }, "ErrorViolation" : { "properties" : { "field" : { "description" : "Field that has the violation", "type" : "string" }, "message" : { "description" : "Error message", "type" : "string" } }, "type" : "object" }, "AuthorizationError" : { "properties" : { "status" : { "description" : "Status code", "type" : "string" }, "message" : { "description" : "Error message", "type" : "string" } }, "required" : [ "message", "status" ], "type" : "object" }, "ConflictError" : { "example" : { "status" : 409, "message" : "error.concurrencyFailure" }, "properties" : { "status" : { "enum" : [ 409 ], "type" : "integer" }, "message" : { "type" : "string" }, "errorKey" : { "type" : "string" } }, "required" : [ "message", "status" ], "type" : "object" }, "UserSecurityInfo" : { "properties" : { "userId" : { "description" : "The user identifier (externally defined)", "type" : "string" }, "tenantId" : { "description" : "Identifies the tenant associated with the request", "type" : "string" }, "authorities" : { "description" : "The authorities given to the user", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "DeploymentListWrapper" : { "allOf" : [ { "$ref" : "#/components/schemas/ListWrapper" }, { "properties" : { "data" : { "items" : { "$ref" : "#/components/schemas/Deployment" }, "type" : "array" } }, "type" : "object" } ], "description" : "Wrapper for Deployment List" }, "DeploymentWrapper" : { "description" : "Wrapper for Deployment", "properties" : { "data" : { "$ref" : "#/components/schemas/Deployment" } }, "required" : [ "data" ], "title" : "DeploymentWrapper", "type" : "object" }, "Deployment" : { "allOf" : [ { "$ref" : "#/components/schemas/AuditInformation" } ], "description" : "Contains information about a deployment.", "properties" : { "id" : { "$ref" : "#/components/schemas/id" }, "version" : { "$ref" : "#/components/schemas/version" }, "name" : { "deprecated" : true, "description" : "The name of the deployment.", "readOnly" : true, "type" : "string" }, "environmentLevel" : { "deprecated" : true, "description" : "The environment level of the deployment - this has the same allowable values as planet class", "readOnly" : true, "type" : "string" }, "supercluster" : { "description" : "Geographical region - centaurus, copeland, pandora, etc", "readOnly" : true, "type" : "string" }, "galaxy" : { "description" : "GWCP name for an AWS region (andromedia, butterfly, needle, etc)", "readOnly" : true, "type" : "string" }, "quadrant" : { "description" : "Cluster name (alpha1, omega2, etc)", "readOnly" : true, "type" : "string" }, "planet" : { "description" : "Planet name", "readOnly" : true, "type" : "string" }, "planetClass" : { "description" : "Planet class - dev, staging, int, prod, etc", "readOnly" : true, "type" : "string" }, "project" : { "description" : "Insurer project", "readOnly" : true, "type" : "string" }, "deploymentId" : { "$ref" : "#/components/schemas/deploymentId" }, "description" : { "description" : "Description of use or purpose.", "type" : "string" }, "lastClientRequest" : { "description" : "Date/Time that configuration was requested for this deployment by a client. \nFor deployments that make frequent requests (or when frequent requests occur), this value may not reflect the time of the actual last request but a time close to the last request (i.e. within 15 minutes). The limited accuracy is intended to avoid requiring frequent database writes when frequent reads occur.", "format" : "date-time", "readOnly" : true, "type" : "string" }, "useGrnCriteriaFormat" : { "deprecated" : true, "description" : "Used to track status of internal status GRN migration. This field is only temporary and will be removed in a future release without notice. Please ignore it. Only users with admin rights can update this flag.", "readOnly" : true, "type" : "string" }, "allowDeprecatedLookup" : { "default" : true, "deprecated" : true, "description" : "Used to track status of internal status GRN migration. This field is only temporary and will be removed in a future release without notice. Please ignore it. Only users with admin rights can update this flag.", "readOnly" : true, "type" : "boolean" }, "normalizedDeploymentId" : { "description" : "Normalized deployment id", "readOnly" : true, "type" : "string" }, "normalizedOn" : { "description" : "Date/time on which the normalized deployment id was added or verified", "format" : "date-time", "readOnly" : true, "type" : "string" } }, "required" : [ "deploymentId" ], "type" : "object" }, "TestDataObjectRequestWrapper" : { "description" : "Wrapper for TestDataObjectsRequest", "properties" : { "data" : { "$ref" : "#/components/schemas/TestDataObjectRequest" } }, "required" : [ "data" ], "title" : "TestDataObjectRequestWrapper", "type" : "object" }, "TestDataObjectRequest" : { "description" : "Object to create test data", "properties" : { "testDataObject" : { "enum" : [ "applicationWithDeploymentLayerSettings", "application" ], "type" : "string" }, "count" : { "default" : 1, "type" : "integer" } }, "required" : [ "testDataObject" ], "title" : "TestDataObjectRequest", "type" : "object" }, "TestDataGetObjectsResponse" : { "description" : "Available test data objects", "properties" : { "testDataObjects" : { "enum" : [ "applicationWithDeploymentLayerSettings", "application" ], "type" : "string" } }, "title" : "TestDataGetObjectsResponse", "type" : "object" }, "TestDataObjectsResponseWrapper" : { "description" : "Wrapper for TestDataObjectsWrapper", "properties" : { "data" : { "$ref" : "#/components/schemas/TestDataObjectsResponse" } }, "required" : [ "data" ], "title" : "TestDataObjectsWrapper", "type" : "object" }, "TestDataObjectsResponse" : { "description" : "Response of available test data objects that can be created", "properties" : { "application" : { "items" : { "$ref" : "#/components/schemas/Application" }, "type" : "array" }, "settingValue" : { "items" : { "$ref" : "#/components/schemas/SettingValue" }, "type" : "array" }, "settingDefinition" : { "items" : { "$ref" : "#/components/schemas/SettingDefinitionResponse" }, "type" : "array" } }, "title" : "TestDataObjectsResponse", "type" : "object" }, "Subscription" : { "description" : "Defines subscription of one setting to another", "properties" : { "publisherApplicationId" : { "description" : "Application ID of the published setting that the subscribed setting is subscribed to", "format" : "int64", "readOnly" : true, "type" : "integer" }, "publisherSettingDefinitionId" : { "description" : "Setting definition ID of the published setting that the subscribed setting is subscribed to", "format" : "int64", "readOnly" : true, "type" : "integer" }, "subscriberApplicationId" : { "description" : "Application ID of the subscribed setting", "format" : "int64", "readOnly" : true, "type" : "integer" }, "subscriberSettingDefinitionId" : { "description" : "Setting definition ID of the subscribed setting", "format" : "int64", "readOnly" : true, "type" : "integer" }, "dryRunResult" : { "$ref" : "#/components/schemas/DryRunResult" } }, "required" : [ "publisherApplicationId", "publisherSettingDefinitionId", "subscriberApplicationId", "subscriberSettingDefinitionId" ], "type" : "object" }, "DryRunResult" : { "description" : "Describes the differences between the publisher and subscriber setting values. Only populated when the `dryRun` query parameter is set to `true`.", "properties" : { "problems" : { "description" : "Describes any issues that will prevent the subscription from being created.", "items" : { "type" : "string" }, "type" : "array" }, "overwriteSubscriberValuesCode" : { "description" : "Required value of the overwriteSubscriberValues parameter needed to overwrite the subscriber values. Only populated when attempting to create a new subscription with the `dryRun` parameter set to true.", "type" : "string" }, "differences" : { "$ref" : "#/components/schemas/DryRunResult_differences" }, "changesToApplyToSubscriber" : { "description" : "Changes that will be applied to the subscriber if the overwriteSubscriberValuesCode is supplied.", "items" : { "$ref" : "#/components/schemas/SubscriberChangeSet" }, "type" : "array" } }, "type" : "object" }, "SubscriberChangeSet" : { "description" : "Changes to apply to the subscriber for a single tenant", "properties" : { "tenantName" : { "type" : "string" }, "create" : { "description" : "Setting values to be created for the subscriber", "items" : { "$ref" : "#/components/schemas/SubscriberChange" }, "type" : "array" }, "update" : { "description" : "Setting values to be updated for the subscriber", "items" : { "$ref" : "#/components/schemas/SubscriberChangeUpdate" }, "type" : "array" }, "delete" : { "description" : "Setting values to be deleted for the subscriber", "items" : { "$ref" : "#/components/schemas/SubscriberChange" }, "type" : "array" } }, "type" : "object" }, "SubscriberChange" : { "allOf" : [ { "$ref" : "#/components/schemas/SubscriberChangeBase" } ], "properties" : { "value" : { "type" : "string" } }, "type" : "object" }, "SubscriberChangeUpdate" : { "allOf" : [ { "$ref" : "#/components/schemas/SubscriberChangeBase" } ], "properties" : { "oldValue" : { "type" : "string" }, "newValue" : { "type" : "string" } }, "type" : "object" }, "SubscriberChangeBase" : { "description" : "Change to be applied to the subscriber", "properties" : { "applyTo" : { "$ref" : "#/components/schemas/SettingValueApplyTo" } }, "type" : "object" }, "SubscriptionRequestWrapper" : { "allOf" : [ { "properties" : { "data" : { "$ref" : "#/components/schemas/SubscriptionRequest" } }, "required" : [ "data" ], "type" : "object" } ], "description" : "Wrapper for subscription request", "type" : "object" }, "SubscriptionRequest" : { "description" : "Request to create a subscription to a published setting definition", "properties" : { "publisherApplicationId" : { "format" : "int64", "type" : "integer" }, "publisherSettingDefinitionId" : { "format" : "int64", "type" : "integer" } }, "required" : [ "publisherApplicationId", "publisherSettingDefinitionId" ], "type" : "object" }, "SubscriptionResponseWrapper" : { "description" : "Wrapper for subscription response", "properties" : { "data" : { "$ref" : "#/components/schemas/Subscription" } }, "required" : [ "data" ], "type" : "object" }, "SecretRotationStatus" : { "description" : "Status of rotation and / or rotation phase.

Possible values:

", "type" : "string", "x-extensible-enum" : [ "CANCELLED", "COMPLETED", "FAILED", "IN_PROGRESS", "INCOMPLETE", "PENDING" ] }, "SecretRotation" : { "description" : "Contains the details for a given rotation.", "properties" : { "id" : { "$ref" : "#/components/schemas/id" }, "applicationId" : { "$ref" : "#/components/schemas/applicationId" }, "settingValueId" : { "$ref" : "#/components/schemas/settingValueId" }, "rotationReason" : { "description" : "The reason for rotation.", "type" : "string" }, "status" : { "allOf" : [ { "$ref" : "#/components/schemas/SecretRotationStatus" } ], "readOnly" : true }, "statusReason" : { "description" : "Provides additional details explaining the rotation's current status or outcome.", "readOnly" : true, "type" : "string" }, "phases" : { "description" : "A collection of rotation phases (or steps) associated with the rotation, including their execution status and results.

Collectively, phases describe the rotation workflow and the current state of the workflow.", "items" : { "$ref" : "#/components/schemas/SecretRotationPhase" }, "readOnly" : true, "type" : "array" }, "startedBy" : { "description" : "The user that started / triggered the rotation", "readOnly" : true, "type" : "string" }, "startedOn" : { "description" : "The timestamp indicating when rotation started.", "format" : "date-time", "readOnly" : true, "type" : "string" }, "endedOn" : { "description" : "The timestamp indicating when the rotation finished.", "format" : "date-time", "readOnly" : true, "type" : "string" }, "lastPhaseTransitionOn" : { "description" : "The timestamp of the most recent change in a phase’s status within the rotation, indicating when the last phase transition occurred.", "format" : "date-time", "readOnly" : true, "type" : "string" } }, "required" : [ "applicationId", "rotationReason", "settingValueId" ], "type" : "object" }, "SecretRotationPhase" : { "description" : "Represents a distinct step within the rotation workflow / process.", "properties" : { "name" : { "description" : "The name of the phase, identifying the specific step or stage within the workflow.", "readOnly" : true, "type" : "string" }, "status" : { "allOf" : [ { "$ref" : "#/components/schemas/SecretRotationStatus" } ], "readOnly" : true }, "startedOn" : { "description" : "The timestamp indicating when the phase began execution.", "format" : "date-time", "readOnly" : true, "type" : "string" }, "endedOn" : { "description" : "The timestamp indicating when the phase finished execution, regardless of whether it completed successfully or failed.", "format" : "date-time", "readOnly" : true, "type" : "string" } }, "type" : "object" }, "SecretRotationRequest" : { "description" : "A request for creating a manual Secret Rotation", "properties" : { "applicationId" : { "$ref" : "#/components/schemas/applicationId" }, "settingValueId" : { "$ref" : "#/components/schemas/settingValueId" }, "rotationReason" : { "description" : "The reason for rotation.", "type" : "string" } }, "required" : [ "applicationId", "rotationReason", "settingValueId" ], "type" : "object" }, "SecretRotationWrapper" : { "description" : "Wrapper for SecretRotation response object", "properties" : { "data" : { "$ref" : "#/components/schemas/SecretRotation" } }, "required" : [ "data" ], "type" : "object" }, "SecretRotationListWrapper" : { "allOf" : [ { "$ref" : "#/components/schemas/ListWrapper" }, { "properties" : { "data" : { "items" : { "$ref" : "#/components/schemas/SecretRotation" }, "type" : "array" } }, "required" : [ "data" ], "type" : "object" } ], "description" : "Wrapper for a list of SecretRotations", "type" : "object" }, "AuthorizeClientResponse_data" : { "properties" : { "clientId" : { "description" : "Client ID from keti registration.", "minLength" : 1, "nullable" : false, "type" : "string" }, "gwHubInstance" : { "$ref" : "#/components/schemas/GwHubInstance" }, "scopesGranted" : { "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "AuthorizeCustomerAccessResponse_data" : { "properties" : { "mappedRoles" : { "items" : { "$ref" : "#/components/schemas/RoleMappingView" }, "type" : "array" }, "idps" : { "description" : "List of IdPs in which the groups were whitelisted.", "items" : { "$ref" : "#/components/schemas/IdpListItem" }, "type" : "array" } }, "type" : "object" }, "SettingDefinition_publisher" : { "description" : "If this setting defintion is subscribed, this provides details about the publisher and the subscription.", "properties" : { "applicationId" : { "description" : "The id of the publisher's application", "format" : "int64", "readOnly" : true, "type" : "integer" }, "applicationName" : { "description" : "The name of the publisher's application", "readOnly" : true, "type" : "string" }, "settingDefinitionId" : { "description" : "The id of the publisher's setting definition", "format" : "int64", "readOnly" : true, "type" : "integer" }, "settingDefinitionName" : { "description" : "The name of the publisher's setting definition", "readOnly" : true, "type" : "string" }, "subscribedOn" : { "description" : "The date the subscription was created on", "format" : "date-time", "readOnly" : true, "type" : "string" }, "subscribedBy" : { "description" : "The user that created the subscription", "readOnly" : true, "type" : "string" } }, "type" : "object", "example" : null }, "DryRunResult_differences" : { "description" : "Describes the type of differences between the values of the publisher and subscriber. Only populated when attempting to create a new subscription with the `dryRun` parameter set to true.", "properties" : { "code" : { "enum" : [ "no-difference", "publisher-has-no-values", "subscriber-has-no-values", "conflicts" ], "type" : "string" }, "message" : { "type" : "string" } }, "type" : "object" } }, "securitySchemes" : { "Guidewire-Hub" : { "flows" : { "authorizationCode" : { "authorizationUrl" : "https://guidewire-hub.okta.com/oauth2/aus11vix3uKEpIfSI357/v1/authorize", "scopes" : { "groups" : "Obtains group memberships - All users should request this scope", "tenant_id" : "Obtains tenant for users - All users should request this scope" }, "tokenUrl" : "https://guidewire-hub.okta.com/oauth2/aus11vix3uKEpIfSI357/v1/token" } }, "type" : "oauth2" } } } }