Procore.Api.AuthenticationUtilitiesMe (procore_sdk v0.3.0)

API calls for all endpoints tagged AuthenticationUtilitiesMe.

Summary

Functions

Show User Info Returns information on the authenticated user. If a company_id or project_id parameter is included, directory-specific information on the user will also be returned. Returns a globally unique user id (across companies). NOTE: This endpoint does not require the ['Procore-Company-Id' header] (https://developers.procore.com/documentation/tutorial-mpz) to be included on a request unless a company_id or project_id parameter is also included.

Functions

Link to this function

rest_v10_me_get(connection, opts \\ [])

Show User Info Returns information on the authenticated user. If a company_id or project_id parameter is included, directory-specific information on the user will also be returned. Returns a globally unique user id (across companies). NOTE: This endpoint does not require the ['Procore-Company-Id' header] (https://developers.procore.com/documentation/tutorial-mpz) to be included on a request unless a company_id or project_id parameter is also included.

Parameters

  • connection (Procore.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :company_id (integer()): Unique identifier for the company. You must supply either a company_id or project_id in order for a name to be returned.
    • :project_id (integer()): Unique identifier for the project. You must supply either a company_id or project_id in order for a name to be returned.

Returns

  • {:ok, Procore.Model.RestV10MeGet200Response.t} on success
  • {:error, Tesla.Env.t} on failure