# Class Mailchimp_Users

Located at Mailchimp/Users.php

Methods summary
`public` | # `__construct( `Mailchimp` $master )`
`public associative_array` | # `invite( string $email, string $role = 'viewer', string $msg = '' )` Invite a user to your account Invite a user to your account #### Parameters $email `string` $email $role `string` $role $msg `string` $msg #### Returns `associative_array` the method completion status - status string The status (success) of the call if it completed. Otherwise an error is thrown.
`public associative_array` | # `inviteResend( string $email )` Resend an invite a user to your account. Note, if the same address has been invited multiple times, this will simpy re-send the most recent invite Resend an invite a user to your account. Note, if the same address has been invited multiple times, this will simpy re-send the most recent invite #### Parameters $email `string` $email #### Returns `associative_array` the method completion status - status string The status (success) of the call if it completed. Otherwise an error is thrown.
`public associative_array` | # `inviteRevoke( string $email )` Revoke an invitation sent to a user to your account. Note, if the same address has been invited multiple times, this will simpy revoke the most recent invite Revoke an invitation sent to a user to your account. Note, if the same address has been invited multiple times, this will simpy revoke the most recent invite #### Parameters $email `string` $email #### Returns `associative_array` the method completion status - status string The status (success) of the call if it completed. Otherwise an error is thrown.
`public array` | # `invites( )` Retrieve the list of pending users invitations have been sent for. Retrieve the list of pending users invitations have been sent for. #### Returns `array` structs for each invitation, including: - email string the email address the invitation was sent to - role string the role that will be assigned if they accept - sent_at string the time the invitation was sent. this will change if it's resent. - expiration string the expiration time for the invitation. this will change if it's resent. - msg string the welcome message included with the invitation
`public associative_array` | # `loginRevoke( string $username )` Revoke access for a specified login Revoke access for a specified login #### Parameters $username `string` $username #### Returns `associative_array` the method completion status - status string The status (success) of the call if it completed. Otherwise an error is thrown.
`public array` | # `logins( )` Retrieve the list of active logins. Retrieve the list of active logins. #### Returns `array` structs for each user, including: - id int the login id for this login - username string the username used to log in - name string a display name for the account - empty first/last names will return the username - email string the email tied to the account used for passwords resets and the ilk - role string the role assigned to the account - avatar string if available, the url for the login's avatar
`public associative_array` | # `profile( )` Retrieve the profile for the login owning the provided API Key Retrieve the profile for the login owning the provided API Key #### Returns `associative_array` the current user's details, including: - id int the login id for this login - username string the username used to log in - name string a display name for the account - empty first/last names will return the username - email string the email tied to the account used for passwords resets and the ilk - role string the role assigned to the account - avatar string if available, the url for the login's avatar