Member

List definition

{
	"kind": "member",
	"uri": string,
	"url": string,
	"createdAt": integer,
	"status": "pending" | "approved" | "rejected" | "left" | "revoked",
	"isAdmin": boolean,
	"user": {
		...user.base // See User resource definition
	},
	"authentication": {
		"kind": "authentication",
		"type": "saml"|"google"|"email",
		"identifier": string,
		"lastLogin": integer,
		"email": string,
		"affiliations": [],
		"identityProvider": {
			"kind": "identityProvider",
			"domain": string,
			"name": string
		}			
	}
}

Documentation

Fields

List

kind

string

The resource type. Will always be "member".

uri

string

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

For example, /organizations/<orgName>/members/<userName>

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).

status

string The member's current status. Will be one of 'pending', 'approved', 'rejected', 'revoked', 'left'

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. Will contain the contents of the user.base resource definition

authentication

authentication

Authentication information about this member. They are required to assert their identity through this authentication in order to act as a member within the organization.

authentication.kind

string

The resource type. Will always be "authentication".

authentication.type

string The type of authentication used. Valid options are SAML (for SAML based authentication), Google (for sign-in with Google), and Email (for email based sign-in)

authentication.identifier

string

The unique, persistent identifier for the user, as provided by the identity provider (IDP). For email authentication type, this will be the same as authentication.email

authentication.lastLogin

integer

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

authentication.email

string

The email address associated with the authentication

authentication.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.

authentication.identityProvider

object

Information about the identity provider that establishes identity for this authentication.

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).

authentication.identityProvider

.kind

string

The resource type. Will always be "identityProvider".

authentication.identityProvider

.domain

string

The domain name associated with the identityProvider.

If the member authenticates with a personal gmail account, this field will be 'gmail.com'.

authentication.identityProvider

.name

string

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

If the member authenticates with a personal gmail account, this field will be 'GMail'.

Last updated