Skip to content

custom-object.md

Latest commit

 

History

History
256 lines (188 loc) · 8.9 KB

custom-object.md

File metadata and controls

256 lines (188 loc) · 8.9 KB
Raw

Custom Object

5 operation(s). Part of the API index.

Call these as client.<service>.<method>({ ... }). <service> is the client field for this group — the README lists the field name for every service. These pages group operations the way the OpenAPI specification tags them, which is not always one field per page.

createCustomObjectByToken

POST /identity/v2/auth/customobject

Create Custom Object

Creates a Custom Object associated with the authenticated User using an Access Token.

Example

async function callCreateCustomObjectByToken(client: LoginRadius) {
  const customObjectRequest = {  }; //Required
  const customobjectid: string = '<customobjectid>'; //Optional
  const objectname: string = '<objectname>'; //Optional
  const access_token: string = '<access_token>'; //Optional
  const prevent_webhook: string = '<prevent_webhook>'; //Optional
  const X-PreventWebhook: string = '<X-PreventWebhook>'; //Optional

  try {
    const res = await client.<service>.createCustomObjectByToken({ customObjectRequest, customobjectid, objectname, access_token, prevent_webhook, X-PreventWebhook });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Parameters

Name In Type Required Description
customobjectid query string no Unique identifier for the Custom Object record
objectname query string no Name of the Custom Object to be used in the request. The name should match the Custom Object configured in your LoginRadius account.
access_token query string no Access Token of the User
prevent_webhook query boolean no When true, suppresses webhook events for this operation.
X-PreventWebhook header boolean no When true, suppresses webhook events for this operation.

Request body

CustomObjectRequest as application/json.

Returns

CustomObjectResponseModel

deleteCustomObjectByTokenAndRecordId

DELETE /identity/v2/auth/customobject/{objectrecordid}

Delete Custom Object by ID

Deletes the Custom Object associated with the specified User using an Access Token and record ID.

Example

async function callDeleteCustomObjectByTokenAndRecordId(client: LoginRadius) {
  const objectrecordid: string = '<objectrecordid>'; //Required
  const access_token: string = '<access_token>'; //Optional
  const prevent_webhook: string = '<prevent_webhook>'; //Optional
  const X-PreventWebhook: string = '<X-PreventWebhook>'; //Optional
  const objectname: string = '<objectname>'; //Optional
  const customobjectid: string = '<customobjectid>'; //Optional

  try {
    const res = await client.<service>.deleteCustomObjectByTokenAndRecordId({ objectrecordid, access_token, prevent_webhook, X-PreventWebhook, objectname, customobjectid });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Parameters

Name In Type Required Description
objectrecordid path string (uuid) yes Unique identifier for the Custom Object record. The ID is used to target a specific Custom Object.
access_token query string no Access Token of the User
prevent_webhook query boolean no When true, suppresses webhook events for this operation.
X-PreventWebhook header boolean no When true, suppresses webhook events for this operation.
objectname query string no Name of the Custom Object to be used in the request. The name should match the Custom Object configured in your LoginRadius account.
customobjectid query string no Unique identifier for the Custom Object record

Returns

IsDeleted

getCustomObjectByToken

GET /identity/v2/auth/customobject

Retrieve Custom Objects

Retrieves Custom Objects associated with the authenticated User using an Access Token.

Example

async function callGetCustomObjectByToken(client: LoginRadius) {
  const customobjectid: string = '<customobjectid>'; //Optional
  const objectname: string = '<objectname>'; //Optional
  const access_token: string = '<access_token>'; //Optional

  try {
    const res = await client.<service>.getCustomObjectByToken({ customobjectid, objectname, access_token });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Parameters

Name In Type Required Description
customobjectid query string no Unique identifier for the Custom Object record
objectname query string no Name of the Custom Object to be used in the request. The name should match the Custom Object configured in your LoginRadius account.
access_token query string no Access Token of the User

Returns

CustomObjectsResponseModel

getCustomObjectByTokenAndRecordId

GET /identity/v2/auth/customobject/{objectrecordid}

Retrieve Custom Object by ID

Retrieves the Custom Object associated with the specified User using an Access Token and record ID.

Example

async function callGetCustomObjectByTokenAndRecordId(client: LoginRadius) {
  const objectrecordid: string = '<objectrecordid>'; //Required
  const access_token: string = '<access_token>'; //Optional
  const objectname: string = '<objectname>'; //Optional
  const customobjectid: string = '<customobjectid>'; //Optional

  try {
    const res = await client.<service>.getCustomObjectByTokenAndRecordId({ objectrecordid, access_token, objectname, customobjectid });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Parameters

Name In Type Required Description
objectrecordid path string (uuid) yes Unique identifier for the Custom Object record. The ID is used to target a specific Custom Object.
access_token query string no Access Token of the User
objectname query string no Name of the Custom Object to be used in the request. The name should match the Custom Object configured in your LoginRadius account.
customobjectid query string no Unique identifier for the Custom Object record

Returns

CustomObjectResponseModel

updateCustomObjectByTokenAndRecordId

PUT /identity/v2/auth/customobject/{objectrecordid}

Update Custom Object by ID

Updates a Custom Object associated with the authenticated User using an Access Token and record ID.

Example

async function callUpdateCustomObjectByTokenAndRecordId(client: LoginRadius) {
  const objectrecordid: string = '<objectrecordid>'; //Required
  const customObjectRequest = {  }; //Required
  const updateType: string = '<updateType>'; //Required
  const objectname: string = '<objectname>'; //Optional
  const access_token: string = '<access_token>'; //Optional
  const prevent_webhook: string = '<prevent_webhook>'; //Optional
  const X-PreventWebhook: string = '<X-PreventWebhook>'; //Optional
  const customobjectid: string = '<customobjectid>'; //Optional

  try {
    const res = await client.<service>.updateCustomObjectByTokenAndRecordId({ objectrecordid, customObjectRequest, updateType, objectname, access_token, prevent_webhook, X-PreventWebhook, customobjectid });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Parameters

Name In Type Required Description
objectrecordid path string (uuid) yes Unique identifier for the Custom Object record. The ID is used to target a specific Custom Object.
objectname query string no Name of the Custom Object to be used in the request. The name should match the Custom Object configured in your LoginRadius account.
updateType query string yes The type of update to be performed on the Custom Object. This parameter is used to specify whether the update should be a full update or a partial update.
access_token query string no Access Token of the User
prevent_webhook query boolean no When true, suppresses webhook events for this operation.
X-PreventWebhook header boolean no When true, suppresses webhook events for this operation.
customobjectid query string no Unique identifier for the Custom Object record

Request body

CustomObjectRequest as application/json.

Returns

CustomObjectResponseModel