Open in Claude Open in ChatGPT

Registration

An Object

Table of Contents
Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Parent

This Registration is contained within a Application.

Properties

The following properties are available:

Property Type Default Read-Only Description
_doc string No The primary ID
_system object No Metadata maintained by the system
active boolean Yes Whether this registration object is active. Active means that it describes a live user account. If a user elects to cancel their registration, the registration object can either be deleted or it can be marked inactive. Inactive accounts remain in the system but are not utilized. They allow the user to register again.
addons object No An array of text containing the addon codes to apply to the created tenant's subscription atop the specified plan.
completed boolean Yes Whether the registration was completed.
completedPrincipalId string Yes The id of the principal that was created as a result of the registration completing.
completedTenantId string Yes The id of the tenant that was created as a result of the registration completing.
confirmationSent boolean Yes Whether the confirmation email was sent.
discounts object No An array of text containing the discount codes to apply to the created tenant's subscription atop the specified plan.
emailProviderId string No The id of the email provider to use for any email-related handling.
emails object No A collection of configuration objects that describe Emails that are to be sent by the registration process. These Email configuration objects are keyed by either: confirmation or welcome.
signupProperties object No An array of additional properties. These are not used by the registration process but will be stored on the registration object as a remnant and may include additional data that the user provided such as the size of their company, project type, etc.
tenantDescription string No The description of the tenant to be created.
tenantPlanKey string No The planKey of the plan to use for the new tenant subscription.
tenantRegistrarId string No The id of the registrar where the tenant should be created.
tenantTitle string No The title of the tenant to be created.
userEmail string No The email address of the domain user to create.
userName string No The name of the domain user to create.
userProperties object No An array of additional properties to apply to the user object when it is created.
userrDomainId string No

Methods

The following methods are available:

Check Permission

Checks whether one or more authorities against the specified registration are granted for a given set of users
POST /applications/{applicationId}/registrations/{registrationId}/permissions/{permissionId}/check

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration
permissionId true string The ID of the permission
id true string

Response

{
  "$ref": "#/components/schemas/checkPermission"
}

Check Registration

POST /applications/{applicationId}/registrations/{registrationId}/check

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration

Check Single Authority

Checks whether a single authority is granted against the specified registration for the given user
POST /applications/{applicationId}/registrations/{registrationId}/authorities/{authorityId}/check

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "check": {
      "type": "boolean"
    },
    "ok": null
  }
}

Check multiple Authorities

Checks whether one or more authorities against the specified registration are granted for a given set of users
POST /applications/{applicationId}/registrations/authorities/check

Parameters

Name Required Type Description
applicationId true string The ID of the application

Response

{
  "type": "object",
  "description": "Check Multiple Authorities Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "authorityId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Check multiple Permissions

Checks whether one or more permissions against the specified registration are granted for a given set of users
POST /applications/{applicationId}/registrations/permissions/check

Parameters

Name Required Type Description
applicationId true string The ID of the application

Response

{
  "type": "object",
  "description": "Check Multiple Permissions Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "permissionId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Confirm Registration

POST /applications/{applicationId}/registrations/{registrationId}/confirm

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration
password false string

Confirmation Send

POST /applications/{applicationId}/registrations/{registrationId}/send/confirmation

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration

Create Registration

Creates a new Registration
POST /applications/{applicationId}/registrations

Parameters

Name Required Type Description
applicationId true string The ID of the application

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Registration

Deletes an existing Registration
DELETE /applications/{applicationId}/registrations/{registrationId}

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Registration

Deletes an existing Registration
POST /applications/{applicationId}/registrations/{registrationId}/delete

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Export Registration

Starts an export job for this resource
POST /applications/{applicationId}/registrations/{registrationId}/export

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Export Configuration",
  "properties": {
    "startDate": {
      "type": "object",
      "description": "Only include objects whose modification date is after this time (epoch millis). This is used for partial or rolling exports."
    },
    "endDate": {
      "type": "object",
      "description": "Only include objects whose modification date is before this time (epoch millis). This is used for partial or rolling exports."
    },
    "startChangeset": {
      "type": "string",
      "description": "Only include data that is relevant to changesets at or beyond the specified changeset."
    },
    "endChangeset": {
      "type": "string",
      "description": "Only include data that is relevant to changesets at or before the specified changeset."
    },
    "includeACLs": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include ACLs during export."
    },
    "includeTeams": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Teams during export."
    },
    "includeActivities": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Activities during export."
    },
    "includeBinaries": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Binaries for data stores during export."
    },
    "includeAttachments": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Attachments for Attachables during export."
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}

Grant Authority

Grants an authority against the specified registration to a given user
POST /applications/{applicationId}/registrations/{registrationId}/authorities/{authorityId}/grant

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Import Registration

Starts an import job for this resource
POST /applications/{applicationId}/registrations/{registrationId}/import

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Import Configuration",
  "properties": {
    "includeACLs": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include ACLs during import."
    },
    "includeTeams": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Teams during import."
    },
    "includeActivities": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Activities during import."
    },
    "includeBinaries": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Binaries for data stores during import."
    },
    "includeAttachments": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Attachments for Attachables during import."
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": "CLONE",
      "description": "Either CLONE or COPY_EVERYTHING. Use CLONE to keep the same IDs on import. Use COPY_EVERYTHING to generate all new IDs for all entries on every import."
    },
    "substitutions": {
      "type": "string"
    }
  }
}

Lists Registration

Retrieves a list of Registration instances
GET /applications/{applicationId}/registrations

Parameters

Name Required Type Description
applicationId true string The ID of the application
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set
This method supports pagination.

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_registration"
      }
    }
  }
}

Lookup Registrations

GET /applications/{applicationId}/registrations/lookup

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration

Queries for Registration

Queries for instances of type Registration
POST /applications/{applicationId}/registrations/query

Parameters

Name Required Type Description
applicationId true string The ID of the application
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set
This method supports pagination.

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_registration"
      }
    }
  }
}

Read ACL

Read the Access Control List for the specified registration
GET /applications/{applicationId}/registrations/{registrationId}/acl/list

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration

Response

{
  "type": "object",
  "description": "Result Map of ACL entries",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "_doc": {
            "type": "string",
            "title": "Principal ID"
          },
          "name": {
            "type": "string",
            "title": "Principal Name"
          },
          "type": {
            "type": "string",
            "title": "Principal Type"
          },
          "domainId": {
            "type": "string"
          },
          "domainQualifiedId": {
            "type": "string"
          },
          "domainQualifiedName": {
            "type": "string"
          },
          "principalId": {
            "type": "string",
            "title": "Principal ID"
          },
          "userEmail": {
            "type": "string"
          },
          "userFirstName": {
            "type": "string"
          },
          "userLastName": {
            "type": "string"
          },
          "authorities": {
            "type": "array",
            "title": "Authorities",
            "items": {
              "type": "string",
              "title": "Authority Key"
            }
          }
        }
      }
    }
  }
}

Read ACL for Principal

Reads the ACL for a registration and specific actor
GET /applications/{applicationId}/registrations/{registrationId}/acl

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration
id true string

Response

{
  "type": "object",
  "description": "Result Map of Authority Keys",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Authority Key"
      }
    }
  }
}

Read Authorities Report

Read the Authorities Report for the specified registration
POST /applications/{applicationId}/registrations/{registrationId}/authorities

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration

Response

{
  "type": "object",
  "description": "Authority Report",
  "properties": {
    "principalId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "object",
          "properties": {
            "role-key": {
              "type": "string"
            },
            "principal": {
              "type": "string"
            },
            "permissioned": {
              "type": "string"
            },
            "inheritsFrom": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "principal": {
                  "type": "string"
                },
                "permissioned": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Read Registration

Reads an instance of a Registration
GET /applications/{applicationId}/registrations/{registrationId}

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration

Response

{
  "type": "object",
  "extends": "document",
  "container": "application",
  "description": "Registration",
  "properties": {
    "userEmail": {
      "type": "string",
      "description": "The email address of the domain user to create."
    },
    "userName": {
      "type": "string",
      "description": "The name of the domain user to create."
    },
    "userrDomainId": {
      "type": "string"
    },
    "userProperties": {
      "type": "object",
      "description": "An array of additional properties to apply to the user object when it is created."
    },
    "signupProperties": {
      "type": "object",
      "description": "An array of additional properties. These are not used by the registration process but will be stored on the registration object as a remnant and may include additional data that the user provided such as the size of their company, project type, etc."
    },
    "tenantTitle": {
      "type": "string",
      "description": "The title of the tenant to be created."
    },
    "tenantDescription": {
      "type": "string",
      "description": "The description of the tenant to be created."
    },
    "tenantPlanKey": {
      "type": "string",
      "description": "The planKey of the plan to use for the new tenant subscription."
    },
    "tenantRegistrarId": {
      "type": "string",
      "description": "The id of the registrar where the tenant should be created."
    },
    "confirmationSent": {
      "type": "boolean",
      "readonly": true,
      "description": "Whether the confirmation email was sent."
    },
    "completed": {
      "type": "boolean",
      "readonly": true,
      "description": "Whether the registration was completed."
    },
    "completedPrincipalId": {
      "type": "string",
      "readonly": true,
      "description": "The id of the principal that was created as a result of the registration completing."
    },
    "completedTenantId": {
      "type": "string",
      "readonly": true,
      "description": "The id of the tenant that was created as a result of the registration completing."
    },
    "emailProviderId": {
      "type": "string",
      "description": "The id of the email provider to use for any email-related handling."
    },
    "emails": {
      "type": "object",
      "description": "A collection of configuration objects that describe Emails that are to be sent by the registration process. These Email configuration objects are keyed by either: confirmation or welcome."
    },
    "discounts": {
      "type": "object",
      "description": "An array of text containing the discount codes to apply to the created tenant's subscription atop the specified plan."
    },
    "addons": {
      "type": "object",
      "description": "An array of text containing the addon codes to apply to the created tenant's subscription atop the specified plan."
    },
    "active": {
      "type": "boolean",
      "readonly": true,
      "description": "Whether this registration object is active. Active means that it describes a live user account. If a user elects to cancel their registration, the registration object can either be deleted or it can be marked inactive. Inactive accounts remain in the system but are not utilized. They allow the user to register again."
    },
    "_doc": null,
    "_system": null
  }
}

Revoke Authority

Revokes an authority against the specified registration from a given user
POST /applications/{applicationId}/registrations/{registrationId}/authorities/{authorityId}/revoke

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update Registration

Updates an existing Registration
PUT /applications/{applicationId}/registrations/{registrationId}

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update Registration

Updates an existing Registration
POST /applications/{applicationId}/registrations/{registrationId}/update

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Welcome Send

POST /applications/{applicationId}/registrations/{registrationId}/send/welcome

Parameters

Name Required Type Description
applicationId true string The ID of the application
registrationId true string The ID of the registration

Schema


{
  "type": "object",
  "extends": "document",
  "container": "application",
  "description": "Registration",
  "properties": {
    "userEmail": {
      "type": "string",
      "description": "The email address of the domain user to create."
    },
    "userName": {
      "type": "string",
      "description": "The name of the domain user to create."
    },
    "userrDomainId": {
      "type": "string"
    },
    "userProperties": {
      "type": "object",
      "description": "An array of additional properties to apply to the user object when it is created."
    },
    "signupProperties": {
      "type": "object",
      "description": "An array of additional properties. These are not used by the registration process but will be stored on the registration object as a remnant and may include additional data that the user provided such as the size of their company, project type, etc."
    },
    "tenantTitle": {
      "type": "string",
      "description": "The title of the tenant to be created."
    },
    "tenantDescription": {
      "type": "string",
      "description": "The description of the tenant to be created."
    },
    "tenantPlanKey": {
      "type": "string",
      "description": "The planKey of the plan to use for the new tenant subscription."
    },
    "tenantRegistrarId": {
      "type": "string",
      "description": "The id of the registrar where the tenant should be created."
    },
    "confirmationSent": {
      "type": "boolean",
      "readonly": true,
      "description": "Whether the confirmation email was sent."
    },
    "completed": {
      "type": "boolean",
      "readonly": true,
      "description": "Whether the registration was completed."
    },
    "completedPrincipalId": {
      "type": "string",
      "readonly": true,
      "description": "The id of the principal that was created as a result of the registration completing."
    },
    "completedTenantId": {
      "type": "string",
      "readonly": true,
      "description": "The id of the tenant that was created as a result of the registration completing."
    },
    "emailProviderId": {
      "type": "string",
      "description": "The id of the email provider to use for any email-related handling."
    },
    "emails": {
      "type": "object",
      "description": "A collection of configuration objects that describe Emails that are to be sent by the registration process. These Email configuration objects are keyed by either: confirmation or welcome."
    },
    "discounts": {
      "type": "object",
      "description": "An array of text containing the discount codes to apply to the created tenant's subscription atop the specified plan."
    },
    "addons": {
      "type": "object",
      "description": "An array of text containing the addon codes to apply to the created tenant's subscription atop the specified plan."
    },
    "active": {
      "type": "boolean",
      "readonly": true,
      "description": "Whether this registration object is active. Active means that it describes a live user account. If a user elects to cancel their registration, the registration object can either be deleted or it can be marked inactive. Inactive accounts remain in the system but are not utilized. They allow the user to register again."
    },
    "_doc": null,
    "_system": null
  },
  "id": "registration"
}