Skip to main content

Project

Properties

NameRequiredTypeDescription
idstring

Logical id of this artifact

Details

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

metaMeta

Details

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesuri

Details

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

languagecode

Details

The base language in which the resource is written.

namestring

Details

A name associated with the Project.

descriptionstring

Details

A summary, characterization or explanation of the Project.

superAdminboolean

Whether this project is the super administrator project.

Details

Whether this project is the super administrator project. A super administrator is a user who has complete access to all resources in all projects.

ownerReference<User>

Details

The user who owns the project.

featurescode[]

Details

A list of optional features that are enabled for the project.

defaultPatientAccessPolicyReference<AccessPolicy>

Details

The default access policy for patients using open registration.

secretProjectSecret[]

Details

Secure environment variable that can be used to store secrets for bots.

namestring

Details

The secret name.

value[x]string, boolean, decimal, integer

Details

The secret value.

siteProjectSite[]

Details

Web application or web site that is associated with the project.

namestring

Details

Friendly name that will make it easy for you to identify the site in the future.

domainstring[]

Details

The list of domain names associated with the site. User authentication will be restricted to the domains you enter here, plus any subdomains. In other words, a registration for example.com also registers subdomain.example.com. A valid domain requires a host and must not include any path, port, query or fragment.

googleClientIdstring

Details

The publicly visible Google Client ID for the site. This is used to authenticate users with Google. This value is available in the Google Developer Console.

googleClientSecretstring

Details

The private Google Client Secret for the site. This value is available in the Google Developer Console.

recaptchaSiteKeystring

Details

The publicly visible reCAPTCHA site key. This value is generated when you create a new reCAPTCHA site in the reCAPTCHA admin console. Use this site key in the HTML code your site serves to users.

recaptchaSecretKeystring

Details

The private reCAPTCHA secret key. This value is generated when you create a new reCAPTCHA site in the reCAPTCHA admin console. Use this secret key for communication between your site and reCAPTCHA.

Search Parameters

NameTypeDescriptionExpression
namestringThe name of the projectProject.name
namereferenceThe user who owns the projectProject.owner
nametokenThe Google Client ID of the projectProject.site.googleClientId
nametokenThe reCAPTCHA site key of the projectProject.site.recaptchaSiteKey

Inherited Properties

NameRequiredTypeDescription