Member

List definition

{
"kind": "member",
"id": integer,
"uri": string,
"url": string,
"createdAt": integer,
"isAdmin": boolean,
"user": {
"kind": "user",
"name": string,
"fullName": string
},
"logins": [
{
"kind": "login",
"identifier": string,
"lastLogin": integer,
"email": string,
"affiliations": [],
"identityProvider": {
"source": string("incommon", "google"),
"entityId": string,
"domain": string,
"name": string
}
}
]
}

Documentation

Fields

List

kind

string

The resource type. Will always be "member".

id

integer

A unique, persistent identifier for the member

uri

string

The fully qualified reference to this member, for use in generating calls to this API.

For example, /my_organization/members/imathews:123

url

string

A url to this member's page on the organization's administration profile

createdAt

integer

When the member was created (joined the organization). Stored as milliseconds since the epoch (1970-01-01).

isAdmin

boolean

Whether or not the member is an administrator of the organization

user

object

A reference to the Redivis user account associated with the member

user.kind

string

Will always be "user".

user.name

string

The account name (username) of the user. Will only contain alphanumeric and underscore characters.

user.fullName

string

The user's full name, as provided by that user

logins

array[object]

A list of login objects associated with this member. This provides information about the user's affiliations and with what entities they have established their identity

logins[].kind

string

The resource type. Will always be "login".

logins[].identifier

string

The unique, persistent identifier for the user, as provided by the identity provider (IDP)

logins[].lastLogin

integer

When the member last authenticated with this login. Stored as milliseconds since the epoch (1970-01-01).

logins[].email

string

The email address associated with the login

logins[].affiliations

array[string]

A list of affiliations, as provided by the eduPersonAffiliation field on the authentication response. Permissible values include: "faculty", "student", "staff", "alum", "member", "affiliate", "employee", "library-walk-in"Please note that most IDPs only use a subset of these values.

logins[].identityProvider

object

Information about the identity provider that the user authenticated with. If a login is associated with a person google account, this field will be null.

logins[].identityProvider

.source

string

The source provider for information about this idp. Will be one of "incommon" or "google".

Redivis supports SAML authentication with any properly configured IDP listed in the InCommon IDP metadata, which contains information on thousands of research institutions from around the world. Additionally, users can log in with any google account. If that account is part of a hosted domain, Redivis treats that hosted domain as an identity provider (for example, my-email@redivis.com is a google account in the "redivis.com" domain).

logins[].identityProvider

.entityId

string

The globally unique entity ID for the identity provider, as provided via InCommon IDP metadata. Will be null if identityProvider.source = 'google'

logins[].identityProvider

.domain

string

The domain name associated with the IDP.

logins[].identityProvider

.name

string

A user-friendly name provided by the IDP. May change and may not be unique.