Unity API Documentation

GET /service/api/console/access/gsm/{gsmKey}/addadminstatus
 ?userEmail={userEmail}
 &confirmEmail={confirmEmail}

Retrieves the status of a GSM add admin access request.

The specified e-mail addresses in the query string of the request need to be URL encoded in order to avoid related request errors (e.g. in case an e-mail address contains characters that are not allowed in a query string).

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode where a specified user should be added as an API-only super admin.

 string

Required
userEmail

The e-mail address of the user which should be added as an API-only super admin to a GSM console.

 string

Required
confirmEmail

The e-mail address where the confirmation message for approving the access request was sent to.

 string

Required

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/console/access/gsm/FB36-7A90-AD22-4214-A7ED/addadminstatus?userEmail=apiuser@mydomain.com&confirmEmail=admin@mydomain.com

Body Parameters

None.

Response Information

Resource Description

The status of a GSM add admin access request.

GSMSuperAdminStatusResponseModel
NameDescriptionTypeAdditional Information
Status

The current status of the request process. The status can be either one of the following texts:

  • "Initiated": The access request has been successfully initiated and the confirmation message was sent out to the target e-mail address.
  • "EmailFailed": The confirmation message could not be sent to the target e-mail address.
  • "PendingApproval": The access request is pending approval.
  • "Approved": The access request has been approved by the GSM console owner.
  • "RequestComplete": The access request process is complete and the user has been added to the GSM console as an API-only super admin.
  • "RequestDenied": The access request process is complete, but the access request has been denied by the GSM console owner.
  • "RequestExpired": The access request process is complete, but the lifetime of the confirmation message has passed by without the GSM console owner acting on the request.

 string

None.
InitiatedDate

The date and time when the access request process was initiated.

 date

None.
StatusChangeDate

The date and time when the status of the access request process was last changed.

 date

None.

Sample Response

{
  "Status": "PendingApproval",
  "InitiatedDate": "2024-04-16T17:08:24.0277387Z",
  "StatusChangeDate": "2024-04-19T10:08:24.0277387Z"
}                    
<GSMSuperAdminStatusResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <InitiatedDate>2024-04-16T17:08:24.0277387Z</InitiatedDate>
  <Status>PendingApproval</Status>
  <StatusChangeDate>2024-04-19T10:08:24.0277387Z</StatusChangeDate>
</GSMSuperAdminStatusResponseModel>