ApplicationRegistration

object

A application’s registration for a specific version of a product.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

statusstringrequired

The status of an application registration request. Each registration is linked to a single version of a product, and application credentials will not grant access to the product version until the registration is approved.
Pending, revoked, and rejected registrations will not provide access to the product version.

Allowed values:approvedpendingrevokedrejected

Example:approved

productobjectrequired

Details about the product the application is registered to.

* Additional properties are NOT allowed.
Show Child Parameters
product_versionobjectrequired

Details about the version of the product the application is registered to.

* Additional properties are NOT allowed.
Show Child Parameters
applicationobjectrequired

Details about the application the registration is part of.

* Additional properties are NOT allowed.
Show Child Parameters
developerobjectrequired

Details about the developer that owns the application the registration is part of.

* Additional properties are NOT allowed.
Show Child Parameters
granted_scopesarray[string]requiredDEPRECATED

Cached list of granted scopes for the registration. Identical for all registrations of an applications, use /portals/{portalId}/applications/{applicationId} to get up to date granted scopes from the IDP. Null if application type does not support returning granted scopes.

Example

ApplicationRegistration

object

A application’s registration for a specific version of a product.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

statusstringrequired

The status of an application registration request. Each registration is linked to a single version of a product, and application credentials will not grant access to the product version until the registration is approved.
Pending, revoked, and rejected registrations will not provide access to the product version.

Allowed values:approvedpendingrevokedrejected

Example:approved

productobjectrequired

Details about the product the application is registered to.

* Additional properties are NOT allowed.
Show Child Parameters
product_versionobjectrequired

Details about the version of the product the application is registered to.

* Additional properties are NOT allowed.
Show Child Parameters
applicationobjectrequired

Details about the application the registration is part of.

* Additional properties are NOT allowed.
Show Child Parameters
developerobjectrequired

Details about the developer that owns the application the registration is part of.

* Additional properties are NOT allowed.
Show Child Parameters
granted_scopesarray[string]requiredDEPRECATED

Cached list of granted scopes for the registration. Identical for all registrations of an applications, use /portals/{portalId}/applications/{applicationId} to get up to date granted scopes from the IDP. Null if application type does not support returning granted scopes.

Example

VerifyPortalDomainsResponse

object

Details about the current status of a custom domain.

* Additional properties are NOT allowed.
is_cname_verifiedbooleanrequiredread-only
is_ssl_issuedbooleanrequiredread-only
Example

BasicDeveloper

object

Basic information about a developer.

idstring(uuid)read-only

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

emailstring(email)

<= 250 characters

Example:developer@email.com

full_namestring

Match pattern:^[\w \W]+$

<= 250 characters

Example:API Developer

activebooleanread-only

Example:true

created_atstring(date-time)read-only

Example:2022-02-07T17:46:57.52Z

updated_atstring(date-time)read-only

Example:2022-10-08T17:00:00.52Z

Example

PortalDeveloper

object
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

emailstring(email)required

<= 255 characters

full_namestringrequired

<= 255 characters

statusstringrequired

The status of a developer in a portal. Approved developers can log in, create applications, and view and register for products they have access to. Pending, revoked, and rejected developers cannot login or view any non-public portal information, or create or modify applications or registrations.

Allowed values:approvedpendingrevokedrejected

Example:approved

application_countnumberrequiredread-only

Example:4

Example