Members

Description

A member object stores contact information for api key owners and allows developer portal access.

Object Fields

username

The username field is the primary identifier for a member object.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	255			no	no	yes	yes	yes

created

The date that this object was created.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	20	date-time		yes	yes	no	yes	yes

updated

The date this object was last updated.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	20	date-time		yes	yes	no	yes	yes

email

The primary email address for this member

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	255			no	no	yes	yes	yes

display_name

This is the name the portal will show publicly for this member.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	255			no	no	yes	yes	yes

uri

User's website uri.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	255			yes	no	yes	yes	no

blog

User's blog uri.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	255			yes	no	yes	yes	no

im

Primary instant messanger screen name

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	255			yes	no	yes	yes	no

imsvc

Service corresponding to the screen name in the im field.

Type is restricted to a specific set of values. See object.describe for a list of available options.

Some examples might include "AIM" for AOL Instant Messenger or "SKYPE" for the Skype service.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	64			yes	no	yes	yes	no

phone

Primary phone number for this user.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	255			yes	no	yes	yes	no

company

User's company name.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	255			yes	no	yes	yes	no

address1

First line of the user's street address.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	255			yes	no	yes	yes	no

address2

Second line of the user's street address.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	255			yes	no	yes	yes	no

locality

The user's city or town.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	255			yes	no	yes	yes	no

region

The user's intra-country region. In the United states, this would be a state. In canada, Its a province.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	50			yes	no	yes	yes	no

postal_code

The postal code for the user's address.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	64			yes	no	yes	yes	no

country_code

The user's country code.

Country code is restricted to a specific set of values. See object.describe for a list of available options.

Country codes are 2 letter ISO 3166 codes.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	8			yes	no	yes	yes	no

first_name

The user's first name

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	255			yes	no	yes	yes	no

last_name

The user's last name

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	255			yes	no	yes	yes	no

registration_ipaddr

The IP address that the user registered with.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	15			yes	no	yes	yes	no

area_status

The user's status.

Area_status is restricted to a specific set of values.

waiting	Waiting for member confirmation	The user cannot use the portal until their status changes
active	Active	The user is active and able to use the portal
disabled	Disabled	The user cannot use the portal
joining	Joining	The member originally registered in another Mashery area and is attempting to join the current one.

See object.describe for a list of available options.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	16		"active"	yes	no	no	yes	no

external_id

External Id is used for synchronizing applications with external systems.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	255			yes	no	no	yes	no

passwd_new

Used to assign the initial password to the member at member creation time. This field will be empty for all existing members.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	32			yes	no	yes	no	no

object_type

The type of the object. This is always "member" for a member.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	32		"member"	yes	yes	no	no	no

Relationships

keys

A member can own several api keys. When this relationship is included with the member, a field by this name will contain an array of key objects.

applications

A member can also own several applications. When this relationship is included with the member, a field by this name will contain an array of application objects.

roles

A member may belong to multiple roles. When this relationship is included with the member, a field by this name will contain an array of role objects.

Object Methods

The member namespace contains methods for manipulating member objects.

member.fetch

Returns an member object based on a specified id.

member.create

Create a new member object.

member.delete

Deletes an existing member object.

member.update

Modifies an existing member object.

member.validate

Validates fields on an member object.

member.addRole

Grants a role to a member.

member.removeRole

Revokes a role from a member.

version 6 as of 13 years ago by Eric Delore