Documentation

OpenID.php

This api exposes CiviCRM OpenID records.

Table of Contents

Functions

civicrm_api3_open_i_d_create()  : array<string|int, mixed>
Add an OpenID for a contact.
_civicrm_api3_open_i_d_create_spec()  : mixed
Adjust Metadata for Create action.
civicrm_api3_open_i_d_delete()  : array<string|int, mixed>
Deletes an existing OpenID.
civicrm_api3_open_i_d_get()  : array<string|int, mixed>
Retrieve one or more OpenID.

Functions

civicrm_api3_open_i_d_create()

Add an OpenID for a contact.

civicrm_api3_open_i_d_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

API result array

_civicrm_api3_open_i_d_create_spec()

Adjust Metadata for Create action.

_civicrm_api3_open_i_d_create_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters
$params : array<string|int, mixed>

Array of parameters determined by getfields.

civicrm_api3_open_i_d_delete()

Deletes an existing OpenID.

civicrm_api3_open_i_d_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

API result array

civicrm_api3_open_i_d_get()

Retrieve one or more OpenID.

civicrm_api3_open_i_d_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>

An associative array of name/value pairs.

Return values
array<string|int, mixed>

API result array


        
On this page

Search results