VOMS Admin REST APIs
A set of APIs to access VOMS user information
Version: 3.7.0
BasePath:/voms/voname/apiv2
Apache 2.0
http://www.apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Lists VOMS users whose membership has expired (listExpiredVoUsers)
Return type
Example data
Content-Type: application/json
{
"expiredUsers" : [ {
"address" : "The Dakota, 1 West 72nd Street, NY, USA",
"creationTime" : "2016-02-11T10:08:40",
"suspensionReason" : "User failed to sign the AUP in time",
"fqans" : [ "/example", "/example/Role=Admin" ],
"suspended" : false,
"institution" : "The Beatles",
"aupAcceptanceRecords" : [ {
"valid" : true,
"daysBeforeExpiration" : 7,
"aupVersion" : "1.0",
"lastAcceptanceDate" : "2017-08-04T12:27:06"
} ],
"emailAddress" : "john@lennon.com",
"phoneNumber" : "+1 9 999 999",
"certificates" : [ {
"creationTime" : "2016-02-11T10:08:40",
"suspensionReason" : "User failed to sign the AUP in time",
"subjectString" : "/C=IT/O=Example/CN=John Lennon",
"suspended" : false,
"issuerString" : "/C=IT/O=Example/CN=Example CA"
} ],
"surname" : "Lennon",
"name" : "John",
"attributes" : [ {
"name" : "nickname",
"value" : "jlennon"
} ],
"pendingSignAUPTask" : {
"lastNotificationTime" : "2017-08-04T13:37:28",
"creationDate" : "2017-08-04T12:27:06",
"expirationDate" : "2017-08-19T13:37:28"
},
"id" : 100,
"endTime" : "2018-02-11T10:08:40",
"supensionReasonCode" : "OTHER"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
A list of VO users whose membership has expired
ExpiredVoUserList
Lists suspended VOMS users (listSuspendedVoUsers)
Return type
Example data
Content-Type: application/json
{
"suspendedUsers" : [ {
"address" : "The Dakota, 1 West 72nd Street, NY, USA",
"creationTime" : "2016-02-11T10:08:40",
"suspensionReason" : "User failed to sign the AUP in time",
"fqans" : [ "/example", "/example/Role=Admin" ],
"suspended" : false,
"institution" : "The Beatles",
"aupAcceptanceRecords" : [ {
"valid" : true,
"daysBeforeExpiration" : 7,
"aupVersion" : "1.0",
"lastAcceptanceDate" : "2017-08-04T12:27:06"
} ],
"emailAddress" : "john@lennon.com",
"phoneNumber" : "+1 9 999 999",
"certificates" : [ {
"creationTime" : "2016-02-11T10:08:40",
"suspensionReason" : "User failed to sign the AUP in time",
"subjectString" : "/C=IT/O=Example/CN=John Lennon",
"suspended" : false,
"issuerString" : "/C=IT/O=Example/CN=Example CA"
} ],
"surname" : "Lennon",
"name" : "John",
"attributes" : [ {
"name" : "nickname",
"value" : "jlennon"
} ],
"pendingSignAUPTask" : {
"lastNotificationTime" : "2017-08-04T13:37:28",
"creationDate" : "2017-08-04T12:27:06",
"expirationDate" : "2017-08-19T13:37:28"
},
"id" : 100,
"endTime" : "2018-02-11T10:08:40",
"supensionReasonCode" : "OTHER"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
A list of suspended VO users
SuspendedVoUserList
Lists VOMS users (listVoUsers)
Returns a list VO users
Query parameters
startIndex (optional)
Query Parameter — The 0-based index of the first query result
pageSize (optional)
Query Parameter — Specifies the desired maximum number of query results per page
Return type
Example data
Content-Type: application/json
{
"result" : [ {
"address" : "The Dakota, 1 West 72nd Street, NY, USA",
"creationTime" : "2016-02-11T10:08:40",
"suspensionReason" : "User failed to sign the AUP in time",
"fqans" : [ "/example", "/example/Role=Admin" ],
"suspended" : false,
"institution" : "The Beatles",
"aupAcceptanceRecords" : [ {
"valid" : true,
"daysBeforeExpiration" : 7,
"aupVersion" : "1.0",
"lastAcceptanceDate" : "2017-08-04T12:27:06"
} ],
"emailAddress" : "john@lennon.com",
"phoneNumber" : "+1 9 999 999",
"certificates" : [ {
"creationTime" : "2016-02-11T10:08:40",
"suspensionReason" : "User failed to sign the AUP in time",
"subjectString" : "/C=IT/O=Example/CN=John Lennon",
"suspended" : false,
"issuerString" : "/C=IT/O=Example/CN=Example CA"
} ],
"surname" : "Lennon",
"name" : "John",
"attributes" : [ {
"name" : "nickname",
"value" : "jlennon"
} ],
"pendingSignAUPTask" : {
"lastNotificationTime" : "2017-08-04T13:37:28",
"creationDate" : "2017-08-04T12:27:06",
"expirationDate" : "2017-08-19T13:37:28"
},
"id" : 100,
"endTime" : "2018-02-11T10:08:40",
"supensionReasonCode" : "OTHER"
} ],
"startIndex" : 0,
"count" : 1,
"pageSize" : 10
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
A list of VO users
VoUserList
[ Jump to Methods ]
Table of Contents
AupAcceptanceRecord - Certificate - ExpiredVoUserList - GenericAttribute - SignAUPTask - SuspendedVoUserList - VoUser - VoUserList -
aupVersion (optional)
String The AUP version signed for this record
daysBeforeExpiration (optional)
Long The number of days before this acceptance record expires format: int64
lastAcceptanceDate (optional)
Date The time when the AUP was last accepted format: date-time
valid (optional)
Boolean The acceptance record validity
subjectString (optional)
String The X.509 certificate subject, in OpenSSL format
issuerString (optional)
String The X.509 certificate issuer, in OpenSSL format
creationTime (optional)
Date The certificate creation time format: date-time
suspended (optional)
Boolean Certificate suspension status
suspensionReason (optional)
String Certificate suspension reason
name (optional)
value (optional)
creationDate (optional)
Date The task creation date format: date-time
expirationDate (optional)
Date The task expiration date format: date-time
lastNotificationTime (optional)
Date The time the user was last notified about this sign AUP task format: date-time
suspendedUsers (optional)
id (optional)
Long VO user record unique identifier format: int64
name (optional)
surname (optional)
institution (optional)
address (optional)
phoneNumber (optional)
suspended (optional)
suspensionReason (optional)
String VO user suspension reason
supensionReasonCode (optional)
String VO user suspension reason code
creationTime (optional)
Date VO user membership creation time format: date-time
endTime (optional)
Date VO user membership expiration time format: date-time
emailAddress (optional)
aupAcceptanceRecords (optional)
certificates (optional)
attributes (optional)
fqans (optional)
pendingSignAUPTask (optional)
count (optional)
Long The total number of users in the VO format: int64
pageSize (optional)
Long The page size for this response format: int64
startIndex (optional)
Long The start index for this response format: int64
result (optional)