provisionProcessors
This section covers the Provision Processors class, for configuring a provision processor’s script and parameters, and the Provision Processors Finder class, for looking up provision processors by organization.
Subsections of provisionProcessors
Provision Processors
This object represents a provision processor and exposes all the attributes you can configure for it.
constructor
Constructor
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| ogapi | InternalOpenGateAPI |
❌ | Reference to the API object. |
withConfigurationParams(configurationParams)
Set the ConfigurationParams attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| configurationParams | object |
❌ | required field |
Retorna
Tip
Tipo: ProvisionPrecessors
withIdentifier(identifier)
Set the identifier attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| identifier | string |
❌ | required field |
Retorna
Tip
Tipo: ProvisionPrecessors
withName(name)
Set the name attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| name | string |
❌ | required field |
Retorna
Tip
Tipo: ProvisionPrecessors
withOrganization(organization)
Set the organization attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| organization | string |
❌ | required field |
Retorna
Tip
Tipo: ProvisionPrecessors
withScriptProcessor(scriptProcessor)
Set the ScriptProcessor attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| scriptProcessor | object |
❌ | required field |
Retorna
Tip
Tipo: ProvisionPrecessors
provision Processors Finder
This class performs GET requests against the provision processors resource in the OpenGate North API.
constructor
Constructor
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| ogapi | InternalOpenGateAPI |
❌ | Reference to the API object. |
findByOrganization(organization)
Performs a get that returns list of provision processors
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| organization | string |
❌ | organization |
Retorna
Tip
Tipo: Promise
findByOrganizationAndProvisionProcessorId(organization, identifier)
Performs a get that returns a definition of provision Processors
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| organization | string |
❌ | organization |
| identifier | string |
❌ | Provision Processors identifier |
Retorna
Tip
Tipo: Promise