class NexaasID::Resources::Profile
A wrapper to Nexaas ID's profile API
- API
-
Documentation:
@example Getting the user's profile:
client = NexaasID::Client::Identity.new(credentials) client.profile.get
@example Getting the user's list of emails:
client = NexaasID::Client::Identity.new(credentials) client.profile.emails
@see NexaasID::Client::Identity#initialize
Public Instance Methods
contacts()
click to toggle source
Retrieves the user's contacts
- API
-
Method:
GET /api/v1/profile/contacts
Documentation:
@return [NexaasID::Entities::Profile::Contacts] user's contacts
# File lib/nexaas_id/resources/profile.rb, line 50 def contacts respond_with_entity(api.get('/api/v1/profile/contacts'), NexaasID::Entities::Profile::Contacts) end
emails()
click to toggle source
Retrieves the user's emails
- API
-
Method:
GET /api/v1/profile/emails
Documentation:
@return [NexaasID::Entities::Profile::Emails] user's emails
# File lib/nexaas_id/resources/profile.rb, line 63 def emails respond_with_entity(api.get('/api/v1/profile/emails'), NexaasID::Entities::Profile::Emails) end
get()
click to toggle source
Retrieves the user's profile
- API
-
Method:
GET /api/v1/profile
Documentation:
@return [NexaasID::Entities::Profile] user's profile
# File lib/nexaas_id/resources/profile.rb, line 25 def get respond_with_entity(api.get('/api/v1/profile')) end
professional_info()
click to toggle source
Retrieves the user's professional info
- API
-
Method:
GET /api/v1/profile/professional_info
Documentation:
@return [NexaasID::Entities::Profile::ProfessionalInfo] user's professional info
# File lib/nexaas_id/resources/profile.rb, line 37 def professional_info respond_with_entity(api.get('/api/v1/profile/professional_info'), NexaasID::Entities::Profile::ProfessionalInfo) end