PolicyCenter Cloud API Developer Guide
Configuring schemas
Overview of schema configuration
Overview of schema configuration files
Syntax for schema configuration files
Adding new properties to schemas
Swagger and apiconfig files
Configuring scalars
Scalars in the schema configuration files
Tutorial: Schema configuration with scalars
Configuring compound datatypes
Overview of schema configuration
Compound datatypes in the schema configuration files
Tutorial: Schema configuration with compound datatypes
Configuring foreign keys
Foreign key properties
Tools for configuring foreign keys
Foreign keys in the schema configuration files
Updater case 1: Root and resolved value have no common ancestor
Updater case 2: Root and resolved value have a common ancestor
Update case 3: Accessibility of resolved value is conditional
Update case 4: Resolved value cannot be easily resolved by id alone
Configuring one-to-ones
One-to-one relationships
Example one-to-one
One-to-one relationships in the schema configuration files
Reserving IDs and checksums
One-to-ones in responses and requests
Complete code sample for one-to-ones
Additional schema behaviors
Property-level behaviors
Read-only properties
Properties required by the database
Properties writeable at creation only
Sortable properties
Filterable properties
Additional metadata for properties
Summary of property attributes
Collection-level behaviors
Obfuscating response data
Localizing schemas
Architecture of localized text
Associating display keys with API elements
Localization key prefixes
Display key patterns for schema.json-files
Display key patterns for swagger.yaml files
Providing locale specific content for a given locale
Adding localized text for existing API elements
Adding localized text for new API elements
Adding a new locale
Generating custom endpoints
The REST endpoint generator
Running the REST endpoint generator
Issues to consider before running the generator
Running the REST endpoint generator
The REST endpoint generator prompts
Completing the configuration
Configuring the resource definition files
The resource definition files
Configuring the schema file for generated endpoints
Configuring the mapping file for generated endpoints
Configuring the updater file for generated endpoints
Configuring the swagger file for generated endpoints
Completing the configuration
Configuring glue and impl classes for generated endpoints
The glue and impl classes for generated endpoints
Completing the configuration
Configuring authorization for generated endpoints
Configuring endpoint access for generated endpoints
Configuring resource access for generated endpoints
Completing the configuration
Additional considerations for generated endpoints
Integration graphs
Base configuration entities
Supertype entities
Generating LOB-specific endpoints
LOB-specific endpoints
Generating and installing LOB-specific endpoints
Disabling product artifacts during testing
Managing LOB-specific endpoints for testing and integration
Generating endpoints for the Personal Auto product
Configuration for other specific use cases
Configuring batch processes
Configuring address locales
Choosing an authentication flow
Overview of authentication
Types of callers
Authentication architecture
Types of access
Authentication methods
Authentication failure error messages
List of developer tasks
Selecting an authentication flow
Auth flows to choose from
Detailed discussion of issues to consider
Which OAuth flow must the caller application use?
Which user is attached to the session?
Where do authorization values come from?
Who enforces resource access?
What values are used as resource access IDs?
Summary of the issues to consider
Additional auth flows
Authentication flows in detail
Basic authentication
Overview of basic authentication
Example flow for basic authentication
Supported environments for basic auth
Implementation checklist for basic authentication
Sending authenticated calls with basic authentication
OAuth2 authorization code flow: Internal users
Overview of authentication for internal users
Example flow for internal users
Implementation checklist for internal users
Sending authenticated calls for internal users
OAuth2 authorization code flow: External users
Overview of authentication for external users
Example flow for external users
Implementation checklist for external users
Sending authenticated calls for external users
OAuth2 authorization code flow: Anonymous users
Overview of authentication for anonymous users
Example flow for anonymous users
Implementation checklist for anonymous users
Creating an account as an unauthenticated user
Recovering incomplete submissions as an unauthenticated user
Sending calls as an anonymous user
OAuth2 client credential flow: Standalone services
Authentication options for services
Overview of authentication for standalone services
Example flow for standalone services
Implementation checklist for standalone services
Sending authenticated calls for standalone services
OAuth2 client credential flow: Services with user context
Authentication options for services
Overview of authentication for services with user context
Example flow for services with user context
Implementation checklist for services with user context
Sending authenticated calls for services with user context
OAuth2 client credential flow: Services with service account mapping
Authentication options for services
Overview of authentication for services with service account mapping
Example flow for services with service account mapping
Implementation checklist for services with service account mapping
Sending authenticated calls for services with service account mapping
Unauthenticated callers
Overview of authentication for unauthenticated callers
Example flow for unauthenticated callers
Implementation checklist for unauthenticated callers
Implementing authentication
Enabling bearer token authentication
Enabling asymmetric encryption
Specifying deployment information
Configuring the IdP
Registering the caller application with Guidewire Hub
Endpoint access
API role files
Assigning API roles to callers
Reserved roles
Designing API role files
Configuring API roles
API roles and localization
Resource access
Resource access strategies
Resource access files
Permissions and filters
Resource permissions
Resource filters
Configuring resource access
Proxy user access
Proxy users
When is proxy user information used?
Configuring proxy users
Security levels
Configuring the reauthorize anonymous user flow
Implementing the /recover-new-jobs endpoint
Define search criteria properties
Define the query logic
Extend the RecoverNewJobsRequestAttributes schema
Calling the /recover-new-jobs endpoint
Configuring general new job recovery behavior
ContactManager authentication
Providing locale specific content for a given locale