class Tickets in Auth0 Single Sign On 8.2

Hierarchy

• class \Auth0\SDK\API\Management\GenericResource
  • class \Auth0\SDK\API\Management\Tickets

1 file declares its use of Tickets

Management.php in vendor/auth0/auth0-php/src/API/Management.php

File

vendor/auth0/auth0-php/src/API/Management/Tickets.php, line 5

Namespace

Auth0\SDK\API\Management

class Tickets extends GenericResource {

  /**
   *
   * @param  string      $user_id
   * @param  null|string $result_url
   * @return mixed
   */
  public function createEmailVerificationTicket($user_id, $result_url = null) {
    $body = [
      'user_id' => $user_id,
    ];
    if ($result_url !== null) {
      $body['result_url'] = $result_url;
    }
    $request = $this->apiClient
      ->method('post')
      ->addPath('tickets')
      ->addPath('email-verification')
      ->withBody(json_encode($body));
    return $request
      ->call();
  }

  /**
   *
   * @param  string      $user_id
   * @param  null|string $new_password
   * @param  null|string $result_url
   * @param  null|string $connection_id
   * @return mixed
   */
  public function createPasswordChangeTicket($user_id, $new_password = null, $result_url = null, $connection_id = null) {
    return $this
      ->createPasswordChangeTicketRaw($user_id, null, $new_password, $result_url, $connection_id);
  }

  /**
   *
   * @param  string      $email
   * @param  null|string $new_password
   * @param  null|string $result_url
   * @param  null|string $connection_id
   * @return mixed
   */
  public function createPasswordChangeTicketByEmail($email, $new_password = null, $result_url = null, $connection_id = null) {
    return $this
      ->createPasswordChangeTicketRaw(null, $email, $new_password, $result_url, $connection_id);
  }

  /**
   *
   * @param  null|string $user_id
   * @param  null|string $email
   * @param  null|string $new_password
   * @param  null|string $result_url
   * @param  null|string $connection_id
   * @return mixed
   */
  public function createPasswordChangeTicketRaw($user_id = null, $email = null, $new_password = null, $result_url = null, $connection_id = null) {
    $body = [];
    if ($user_id) {
      $body['user_id'] = $user_id;
    }
    if ($email) {
      $body['email'] = $email;
    }
    if ($new_password) {
      $body['new_password'] = $new_password;
    }
    if ($result_url) {
      $body['result_url'] = $result_url;
    }
    if ($connection_id) {
      $body['connection_id'] = $connection_id;
    }
    return $this->apiClient
      ->method('post')
      ->addPath('tickets')
      ->addPath('password-change')
      ->withBody(json_encode($body))
      ->call();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
GenericResource::$apiClient	protected	property	Injected ApiClient instance to use.
GenericResource::checkEmptyOrInvalidString	protected	function	Check that a variable is a string and is not empty.
GenericResource::checkInvalidPermissions	protected	function	Check for invalid permissions with an array of permissions.
GenericResource::getApiClient	public	function	Get the injected ApiClient instance.
GenericResource::normalizeIncludeTotals	protected	function	Normalize include_totals parameter.
GenericResource::normalizePagination	protected	function	Normalize pagination parameters.
GenericResource::__construct	public	function	GenericResource constructor.
Tickets::createEmailVerificationTicket	public	function
Tickets::createPasswordChangeTicket	public	function
Tickets::createPasswordChangeTicketByEmail	public	function
Tickets::createPasswordChangeTicketRaw	public	function