Create a Guest
Create a new token for a single guest user. The Service App that creates the guest must have the scope guest-issuer:write.
Guests are implicitly created by retrieving the guest access token.
Repeated calls to this API with the same subject will create additional tokens without invalidating previous ones. Tokens are valid until the expiresIn.
Guests can be renamed by supplying the same subject and changing the displayName.
To retrieve a new token for an existing guest, please provide the existing guest's subject. Tokens are valid until expiresIn.
Body Parameters
The unique and external identifier of the guest.
The display name shown in the Webex application.
Response Properties
The unique id of the guest. This is a personId
The external unique identifier of the guest.
The guest’s display name shown in Webex applications
The person’s synthetic email in Webex.
The guests access token. Guest tokens usually are over 2000 characters in length.
The token expiration in seconds from the time of issuance.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Body
- The unique and external identifier of the guest.
- The display name shown in the Webex application.
{
"subject": "ExternalGuestIdentifier",
"displayName": "John Doe"
}{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zNzlhNWQ4ZC1hNTE4LTQ3NmQtYmY1NC1mZmE5MWQ3OWM4MTI",
"subject": "PersonNo#1",
"displayName": "Person of Interest",
"email": "1ad14c30-59a6-31a7-b345-963e3d167e10@appid.ciscospark.com",
"accessToken": "eyJhbGciOiJSUzI1NiJ9.eyJkw1zx5iIDv7FL3cWQ_JEjehqtPVRmFf572q7RZwSIZgQRziAw",
"expiresIn": 64799
}