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
addons object No
completed boolean Yes
completedPrincipalId string Yes
completedTenantId string Yes
confirmationSent boolean Yes
discounts object No
emailProviderId string No
emails object No
signupProperties object No
tenantDescription string No
tenantPlanKey string No
tenantRegistrarId string No
tenantTitle string No
userEmail string No
userName string No
userProperties object No
userrDomainId string No

Methods

The following methods are available:

Check

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

Response

{}

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
registrationId true string
permissionId true string
id true string

Response

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

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
registrationId true string
authorityId true string
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

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

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

Parameters

Name Required Type Description
applicationId true string
registrationId true string
password false string

Response

{}

Confirmation

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

Parameters

Name Required Type Description
applicationId true string
registrationId true string

Response

{}

Create Registration

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

Parameters

Name Required Type Description
applicationId true string

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
registrationId true string

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
registrationId true string

Response

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

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
registrationId true string
authorityId true string
id true string

Response

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

Lists Registration

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

Parameters

Name Required Type Description
applicationId true string
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

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

GET /applications/{applicationId}/registrations/lookup

Parameters

Name Required Type Description
applicationId true string
registrationId true string

Response

{}

Queries for Registration

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

Parameters

Name Required Type Description
applicationId true string
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

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
registrationId true string

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
registrationId true string
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
registrationId true string

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
registrationId true string

Response

{
  "type": "object",
  "extends": "document",
  "container": "application",
  "description": "Registration",
  "properties": {
    "userEmail": {
      "type": "string"
    },
    "userName": {
      "type": "string"
    },
    "userrDomainId": {
      "type": "string"
    },
    "userProperties": {
      "type": "object"
    },
    "signupProperties": {
      "type": "object"
    },
    "tenantTitle": {
      "type": "string"
    },
    "tenantDescription": {
      "type": "string"
    },
    "tenantPlanKey": {
      "type": "string"
    },
    "tenantRegistrarId": {
      "type": "string"
    },
    "confirmationSent": {
      "type": "boolean",
      "readonly": true
    },
    "completed": {
      "type": "boolean",
      "readonly": true
    },
    "completedPrincipalId": {
      "type": "string",
      "readonly": true
    },
    "completedTenantId": {
      "type": "string",
      "readonly": true
    },
    "emailProviderId": {
      "type": "string"
    },
    "emails": {
      "type": "object"
    },
    "discounts": {
      "type": "object"
    },
    "addons": {
      "type": "object"
    },
    "active": {
      "type": "boolean",
      "readonly": true
    },
    "_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
registrationId true string
authorityId true string
id true string

Response

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

Starts an export job for this resource

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

Parameters

Name Required Type Description
applicationId true string
registrationId true string
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"
    },
    "endDate": {
      "type": "object"
    },
    "startChangeset": {
      "type": "string"
    },
    "endChangeset": {
      "type": "string"
    },
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}

Starts an import job for this resource

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

Parameters

Name Required Type Description
applicationId true string
registrationId true string
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"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "substitutions": {
      "type": "string"
    }
  }
}

Update Registration

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

Parameters

Name Required Type Description
applicationId true string
registrationId 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
POST /applications/{applicationId}/registrations/{registrationId}/update

Parameters

Name Required Type Description
applicationId true string
registrationId true string

Response

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

Welcome

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

Parameters

Name Required Type Description
applicationId true string
registrationId true string

Response

{}

Schema


{
  "type": "object",
  "extends": "document",
  "container": "application",
  "description": "Registration",
  "properties": {
    "userEmail": {
      "type": "string"
    },
    "userName": {
      "type": "string"
    },
    "userrDomainId": {
      "type": "string"
    },
    "userProperties": {
      "type": "object"
    },
    "signupProperties": {
      "type": "object"
    },
    "tenantTitle": {
      "type": "string"
    },
    "tenantDescription": {
      "type": "string"
    },
    "tenantPlanKey": {
      "type": "string"
    },
    "tenantRegistrarId": {
      "type": "string"
    },
    "confirmationSent": {
      "type": "boolean",
      "readonly": true
    },
    "completed": {
      "type": "boolean",
      "readonly": true
    },
    "completedPrincipalId": {
      "type": "string",
      "readonly": true
    },
    "completedTenantId": {
      "type": "string",
      "readonly": true
    },
    "emailProviderId": {
      "type": "string"
    },
    "emails": {
      "type": "object"
    },
    "discounts": {
      "type": "object"
    },
    "addons": {
      "type": "object"
    },
    "active": {
      "type": "boolean",
      "readonly": true
    },
    "_doc": null,
    "_system": null
  },
  "id": "registration"
}