Member

List definition

1
{
2
"kind": "member",
3
"id": integer,
4
"uri": string,
5
"url": string,
6
"createdAt": integer,
7
"isAdmin": boolean,
8
"user": {
9
"kind": "user",
10
"name": string,
11
"fullName": string
12
},
13
"authentication": {
14
"kind": "authentication",
15
"identifier": string,
16
"lastLogin": integer,
17
"email": string,
18
"affiliations": [],
19
"identityProvider": {
20
"kind": "identityProvider",
21
"domain": string,
22
"name": string
23
}
24
}
25
}
Copied!

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
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.identifier
string
The unique, persistent identifier for the user, as provided by the identity provider (IDP)
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, [email protected] 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 modified 1yr ago