Class DeviceRegistrationService

entity or id of registration. Using an entity object one can pass a securityToken as string next to the id.

optional security token to reduce the risk of devices which are not yet registered being taken over by threat actors.

Examples

  const id = 'abc';

  (async () => {
    const {data, res} = await deviceRegistrationService.accept(id);
  })();
Copy

  const entity = { id: 'abc', securityToken: '<secretToken>' };

  (async () => {
    const {data, res} = await deviceRegistrationService.accept(entity);
  })();
Copy

  const id = 'abc';
  const securityToken = '<secretToken>';

  (async () => {
    const {data, res} = await deviceRegistrationService.accept(id, securityToken);
  })();
Copy

Providing a securityToken within an entity object together with another securityToken as a parameter of the method will always use the securityToken of the entity object. In the example below is used as the value. is obsolete and ignored.

  const entity = { id: 'abc', securityToken: '<secretTokenA>'};
  const securityToken = '<secretTokenB>';

  (async () => {
    const {data, res} = await deviceRegistrationService.accept(entity, securityToken);
  })();

Copy

entity or id of registration. Using an entity object one can pass a securityToken as string next to the id.

for details see [[IDeviceBootstrapOptions]]

optional security token to reduce the risk of devices which are not yet registered being taken over by threat actors.

Examples

  const id: 'abc';
  const options: IDeviceBootstrapOptions = {
    basicAuthToken: 'Basic dGVuYW50L3VzZXJuYW1lOnBhc3N3b3Jk',
    basicAuth: {
      user: 'username',
      pass: 'password'
    }
  };

  (async () => {
    const {data, res} = await deviceRegistrationService.bootstrap(id, options);
  })();
Copy

  const entity: { id: '123', securityToken: '<secretToken>'};
  const options: IDeviceBootstrapOptions = {
    basicAuthToken: 'Basic dGVuYW50L3VzZXJuYW1lOnBhc3N3b3Jk',
    basicAuth: {
      user: 'username',
      pass: 'password'
    }
  };

  (async () => {
    const {data, res} = await deviceRegistrationService.bootstrap(entity, options);
  })();
Copy

  const id: '123';
  const options: IDeviceBootstrapOptions = {
    basicAuthToken: 'Basic dGVuYW50L3VzZXJuYW1lOnBhc3N3b3Jk',
    basicAuth: {
      user: 'username',
      pass: 'password'
    }
  };
 const securityToken: '<secretToken>'

  (async () => {
    const {data, res} = await deviceRegistrationService.bootstrap(id, options, securityToken);
  })();
Copy

Providing a securityToken within an entity object together with another securityToken as a parameter of the method will always use the securityToken of the entity object. In the example below is used as the value. is obsolete and ignored.

  const options: IDeviceBootstrapOptions = {
    basicAuthToken: 'Basic dGVuYW50L3VzZXJuYW1lOnBhc3N3b3Jk',
    basicAuth: {
      user: 'username',
      pass: 'password'
    }
  };
 const entity: { id: '123', securityToken: '<secretTokenA>'};
 const securityToken: '<secretTokenB>'

  (async () => {
    const {data, res} = await deviceRegistrationService.accept(entity, securityToken);
  })();
Copy

Device registration object with mandantory fragments.

entity or id of the registration.

Example

  const id = 'abc';

  (async () => {
    const {data, res} = await deviceRegistrationService.delete(id);
    // data will be null
  })();
Copy

Entity or Id of the entity.

Object containing filters for querying registrations.

Example

  const filter: object = {
    pageSize: 100,
    withTotalPages: true
  };

  (async () => {
    const {data, res, paging} = await deviceRegistrationService.list(filter);
  })();
Copy