{
"openapi": "3.0.0",
"info": {
"title": "Webex Admin",
"version": "1.0.0",
"description": "The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling."
},
"tags": [
{
"name": "Service Apps",
"description": "Operations for managing Service App access tokens"
}
],
"paths": {
"/adminAudit/events": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Content-Disposition": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditEventCollectionResponse"
},
"example": {
"items": [
{
"data": {
"actorOrgName": "Acme Inc.",
"targetName": "Acme Inc.",
"eventDescription": "An Admin logged in",
"actorName": "Joe Smith",
"actorEmail": "joe@example.com",
"adminRoles": [
"User"
],
"trackingId": "ATLAS_6f23a878-bcd4-c204-a4db-e701b42b0e5c_0",
"targetType": "TargetResourceType.ORG",
"targetId": "NWIzZTBiZDgtZjg4Ni00MjViLWIzMTgtYWNlYjliN2EwZGFj",
"eventCategory": "EventCategory.LOGINS",
"actorUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
"actorIp": "128.107.241.191",
"targetOrgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"actionText": "Joe Smith logged into organization Acme Inc.",
"targetOrgName": "Acme Inc."
},
"created": "2019-01-02T16:58:36.845Z",
"actorOrgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"id": "MjQ0ODhiZTYtY2FiMS00ZGRkLTk0NWQtZDFlYjkzOGQ4NGUy",
"actorId": "MjQ4Njg2OTYtYWMwZC00ODY4LWJkMjEtZGUxZDc4MzhjOTdm"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Admin Audit Events",
"operationId": "List Admin Audit Events",
"description": "List admin audit events in your organization. Several query parameters are available to filter the response.\n\nLong result sets will be split into [pages](/docs/basics#pagination).\n\n**NOTE**: A maximum of one year of audit events can be returned per request.",
"tags": [
"Admin Audit Events"
],
"parameters": [
{
"name": "orgId",
"in": "query",
"description": "List events in this organization, by ID.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "List events which occurred after a specific date and time.",
"required": true,
"example": "2018-01-01T13:12:11.789Z",
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"description": "List events which occurred before a specific date and time.",
"required": true,
"example": "2018-01-01T14:12:11.789Z",
"schema": {
"type": "string"
}
},
{
"name": "actorId",
"in": "query",
"description": "List events performed by this person, by ID.",
"example": "ZWUzNDNmYjEtNGQzNS00ZjNmLWE2ZDctMzZkNzVlYjk0ZWVm",
"schema": {
"type": "string"
}
},
{
"name": "max",
"in": "query",
"description": "Limit the maximum number of events in the response. The maximum value is `200`.",
"example": "100",
"schema": {
"type": "number",
"default": 100
}
},
{
"name": "offset",
"in": "query",
"description": "Offset from the first result that you want to fetch.",
"example": "0",
"schema": {
"type": "number"
}
},
{
"name": "eventCategories",
"in": "query",
"description": "List events, by event categories.",
"example": "LOGINS,LOGOUT",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "LOGINS,LOGOUT"
},
"description": "List events, by event categories."
}
}
]
}
},
"/adminAudit/eventCategories": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditEventCategoryCollectionResponse"
},
"example": {
"eventCategories": []
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Admin Audit Event Categories",
"operationId": "List Admin Audit Event Categories",
"description": "Get the list of all admin event categories.",
"tags": [
"Admin Audit Events"
],
"parameters": []
}
},
"/authorizations": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListAuthorizations"
},
"example": {
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL0FVVEhPUklaQVRJT04vZjI3MDM0ZTMtMDA5ZS00ODA4LTk5MDQtNTNkMDQ0OGJlNDVk",
"applicationId": "Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL0NmMzkyNWU5NDFmMzhhYTc0M2Y0MmFiNzcwZmZhZjFhNTIyMjcxZDI5OTQ4NDhjNjk2YWMwYTEwN2Q2YTg5MjI3",
"applicationName": "Developer Portal",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lYjIyYjNiZC03NGNiLTRjMjktYjA3Zi1lYWQwMmU1NjgyZDI",
"clientId": "C80fb9c7096bd8474627317ee1d7a817eff372ca9c9cee3ce43c3ea3e8d1511ec",
"created": "2015-10-18T14:26:16+00:00",
"type": "refresh"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List authorizations for a user",
"operationId": "listAuthorizationsForUser",
"description": "Lists all authorizations for a user. Either `personId` or `personEmail` must be provided. This API does not support pagination.",
"tags": [
"Authorizations"
],
"parameters": [
{
"name": "personId",
"in": "query",
"description": "List authorizations for this user id.",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"schema": {
"type": "string"
}
},
{
"name": "personEmail",
"in": "query",
"description": "List authorizations for this user email.",
"example": "john.anderson@example.com",
"schema": {
"type": "string"
}
}
]
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Delete authorization of org and client ID",
"operationId": "Delete authorization of org and client ID",
"description": "Deletes an authorization by org ID and client ID.",
"tags": [
"Authorizations"
],
"parameters": [
{
"name": "clientId",
"in": "query",
"description": "The unique oAuth client id.",
"required": true,
"example": "C80fb9c7096bd8474627317ee1d7a817eff372ca9c9cee3ce43c3ea3e8d1511ec",
"schema": {
"type": "string"
}
},
{
"name": "orgId",
"in": "query",
"description": "The ID of the organization to which this person belongs. If no orgId is specified, use orgId from the OAuth token.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"schema": {
"type": "string"
}
}
]
}
},
"/authorizations/{authorizationId}": {
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Delete authorization",
"operationId": "Delete authorization",
"description": "Deletes an authorization by authorization ID.\n\nSpecify the authorization Id in the `authorizationId` parameter in the URI, which was listed in the list resource.",
"tags": [
"Authorizations"
],
"parameters": [
{
"name": "authorizationId",
"in": "path",
"description": "The unique identifier for the message.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL0FVVEhPUklaQVRJT04vZjI3MDM0ZTMtMDA5ZS00ODA4LTk5MDQtNTNkMDQ0OGJlNDVk",
"schema": {
"type": "string"
}
}
]
}
},
"/authorizations/tokenExpiry": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"exp": {
"type": "number",
"description": "Epoch time in milliseconds at which the current token will expire."
}
},
"required": [
"exp"
]
},
"example": {
"exp": 1768630439322
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get expiration status for a token",
"operationId": "getTokenExpirationStatus",
"description": "Epoch-based expiration time for the token.",
"tags": [
"Authorizations"
]
}
},
"/classifications": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationsSpaceClassificationCollectionResponse"
},
"example": {
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL0NMQVNTSUZJQ0FUSU9OL2YyMDUyZTgyLTU0ZjgtMTFlYS1hMmUzLTJlNzI4Y2U4ODEyNQ",
"rank": 0,
"title": "Public",
"enabled": true,
"description": "Does not contain private information",
"lastModified": "2020-02-22T00:06:42.438Z",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List classifications",
"operationId": "List classifications",
"description": "List all the space classifications configured in your org.",
"tags": [
"Classifications"
],
"parameters": []
}
},
"/dataSources": {
"post": {
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"audience": "MedDocVirtualAgent",
"errorMessage": "down for maintenance",
"id": "f29bb291-5db0-411b-834a-e64f8dee0658",
"nonce": "jeieu38udue83u398",
"schemaId": "78efc775-dccb-45ca-9acf-989a4a59f788",
"status": "active",
"subject": "callAudioData",
"tokenLifetimeMinutes": 60,
"url": "https://www.byods.com/service1"
}
}
},
"schema": {
"properties": {
"audience": {
"description": "The audience field in the JWT token. Usually, the DAPs app name.",
"type": "string"
},
"errorMessage": {
"description": "Error Message shown in Control Hub when status is set to `disabled`.",
"type": "string"
},
"id": {
"description": "The Data Source Id.",
"type": "string"
},
"nonce": {
"description": "Unique nonce used in the encryption of the JWT token.",
"type": "string"
},
"schemaId": {
"description": "The schema id used for the data exchange.",
"type": "string"
},
"status": {
"description": "The status of the Data Source; `active` or `disabled`",
"type": "string"
},
"subject": {
"description": "Rhe subject field in the JWT token. Usually, an indication of the app's function",
"type": "string"
},
"tokenLifetimeMinutes": {
"description": "The validity of the created token in minutes. Before the token expiration time, a new token must be provided, or Webex will stop delivering data after the token expiration",
"type": "number"
},
"url": {
"description": "The URL of the endpoint where Webex will send the data.",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "OK",
"headers": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"tags": [
"Data Sources"
],
"description": "Register your data source to the Webex BYODS system. Authentication must happen via a Service App with the scope `spark-admin:datasource_write`.\nThe schema IDs determine what data types are sent from Webex to the DAP and the expected responses. The schemas can be inspected on developer.webex.com.",
"operationId": "Register a Data Source",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"audience": "MedDocVirtualAgent",
"nonce": "jeieu38udue83u398",
"schemaId": "78efc775-dccb-45ca-9acf-989a4a59f788",
"subject": "callAudioData",
"tokenLifetimeMinutes": 60,
"url": "https://www.byods.com/service1"
},
"properties": {
"audience": {
"description": "The audience field in the JWT token. Usually, the DAPs app name.",
"type": "string"
},
"nonce": {
"description": "Unique nonce used in the encryption of the JWT token.",
"type": "string"
},
"schemaId": {
"description": "The schema id used for the data exchange.",
"type": "string"
},
"subject": {
"description": "Rhe subject field in the JWT token. Usually, an indication of the app's function",
"type": "string"
},
"tokenLifetimeMinutes": {
"description": "The validity of the created token in minutes. Before the token expiration time, a new token must be provided, or Webex will stop delivering data after the token expiration. Must be equal or less to 1440.",
"type": "number"
},
"url": {
"description": "The URL of the endpoint where Webex will send the data.",
"type": "string"
}
},
"type": "object"
}
}
}
},
"summary": "Register a Data Source"
}
},
"/dataSources/": {
"get": {
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"DataSource": "",
"applicationId": "Cf2e954e018f2de8c1403e2618323551df65",
"createdAt": "2022-01-01T00:00:00Z",
"createdBy": "3e4d3b27-1bf1-4916-8d0c-d27fd765fa52",
"jwsToken": "eyJraWQiOiIxOWFmMzYxYS0zYWI0LTU0NzEtYTViMC03MmQxODQyOTRjMmYiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJNeUFwcDIiLCJzdWIiOiJNeUFwcHNQdXJwb3NlMiIsImlzcyI6Imh0dHBzOlwvXC9pZGJyb2tlci53ZWJleC5jb21cL2lkYiIsImV4cCI6MTcyOTIyMDUxNSwiY29tLmNpc2NvLmRhdGFzb3VyY2UudXJsIjoiaHR0cHM6XC9cL3NjaGlmZmVydC5tZVwvZHMyIiwiY29tLmNpc2NvLmRhdGFzb3VyY2Uuc2NoZW1hLnV1aWQiOiI3OGVmYzc3NS1kY2NiLTQ1Y2EtOWFjZi05ODlhNGE1OWY3ODgiLCJpYXQiOjE3MjkyMTMzMTUsImNvbS5jaXNjby5vcmcudXVpZCI6ImNlODYxZmJhLTZlMmYtNDlmOS05YTg0LWIzNTQwMDhmYWM5ZSIsImp0aSI6IjEyMzQ1NiJ9.QxWYQCXOTLTNBx1Mr8qtd1rpx5uqHYcow1l_oiqMQ_2LorPor3wnEW9_dmMFUs-yAizpayTB4XJpU0ga9E-GY3XaiXz4CGW0G5f3566j3AvmfviMVCFgQFnMd0LpwgPIHhQGX-z2Y6KgzjTCLqm76WpSylAomOPEpgs8dqChfuC9aVHyuB2FfV77J265q-pLp8RSJa_EoSZ_05tpQHxxrDrB-qnn-WQoCFFlb88f3kKdyzPqQhvdWQuouyaP4YyMd_C8a6N_F1dk3cBUjSOtnHDm9WoGwYd8wUcjtZVk5g-z7coc656OooRvDQ0-JRdh7TVUfkzdQS79d4UfmRAhYQ",
"orgId": "63b02f90-9cc6-43b8-aa6d-cad425ac554c"
}
]
}
}
},
"schema": {
"properties": {
"items": {
"items": {},
"type": "array"
}
},
"type": "object"
}
}
},
"description": "OK",
"headers": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"tags": [
"Data Sources"
],
"description": "Show all data sources registered for this Service App with the scope `spark-admin:datasource_read`.",
"operationId": "Retrieve All Data Sources",
"summary": "Retrieve All Data Sources"
}
},
"/dataSources/schemas": {
"get": {
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"appType": "serviceApp",
"createdAt": "2024-09-05T01:35:04.772Z",
"id": "78efc775-dccb-45ca-9acf-989a4a59f788",
"protocol": "gRPC",
"serviceType": "webService",
"url": "/path/to/definition/file3"
}
]
}
}
},
"schema": {
"properties": {
"items": {
"items": {},
"type": "array"
}
},
"type": "object"
}
}
},
"description": "OK",
"headers": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"tags": [
"Data Sources"
],
"description": "Show available schemas. No specific scope is needed to retrieve the dataSource schemas, but a valid API token should be presented.",
"operationId": "Retrieve Data Source Schemas",
"summary": "Retrieve Data Source Schemas"
}
},
"/dataSources/schemas/{schemaId}": {
"get": {
"parameters": [
{
"description": "The unique identifier for the schema.",
"example": "78efc775-dccb-45ca-9acf-989a4a59f788",
"in": "path",
"name": "schemaId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"appType": "serviceApp",
"createdAt": "2024-09-05T01:35:04.772Z",
"id": "78efc775-dccb-45ca-9acf-989a4a59f788",
"protocol": "gRPC",
"serviceType": "webService",
"url": "/path/to/definition/file3"
}
}
},
"schema": {
"properties": {
"appType": {
"description": "The app type used for this schema",
"type": "string"
},
"createdAt": {
"description": "datetime when the schema was created",
"type": "string"
},
"id": {
"description": "The Schema Id",
"type": "string"
},
"protocol": {
"description": "The connection protocol for this schema",
"type": "string"
},
"serviceType": {
"description": "The service type web or contact center",
"type": "string"
},
"url": {
"description": "the URL location where this schema can be inspected",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "OK",
"headers": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"tags": [
"Data Sources"
],
"description": "Retrieve details of a specific data source schema by schema id. No specific scope is needed to retrieve the dataSource schemas, but a valid API token should be presented.",
"operationId": "Retrieve Details of a Specific Data Source Schema",
"summary": "Retrieve Details of a Specific Data Source Schema"
}
},
"/dataSources/{dataSourceId}": {
"delete": {
"parameters": [
{
"description": "The unique identifier for the dataSource.",
"example": "f29bb291-5db0-411b-834a-e64f8dee0658",
"in": "path",
"name": "dataSourceId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"tags": [
"Data Sources"
],
"description": "Delete a Data Source, by Data Source ID.\n\nSpecify the Data Source ID in the `dataSourceId` parameter in the URI.",
"operationId": "Delete a Data Source",
"summary": "Delete a Data Source"
},
"get": {
"parameters": [
{
"description": "The unique identifier for the dataSource.",
"example": "f29bb291-5db0-411b-834a-e64f8dee0658",
"in": "path",
"name": "dataSourceId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"audience": "MedDocVirtualAgent",
"errorMessage": "down for maintenance",
"id": "f29bb291-5db0-411b-834a-e64f8dee0658",
"nonce": "jeieu38udue83u398",
"schemaId": "78efc775-dccb-45ca-9acf-989a4a59f788",
"status": "active",
"subject": "callAudioData",
"tokenLifetimeMinutes": 60,
"url": "https://www.byods.com/service1"
}
}
},
"schema": {
"properties": {
"audience": {
"description": "The audience field in the JWT token. Usually, the DAPs app name.",
"type": "string"
},
"errorMessage": {
"description": "Error Message shown in Control Hub when status is set to `disabled`.",
"type": "string"
},
"id": {
"description": "The Data Source Id.",
"type": "string"
},
"nonce": {
"description": "Unique nonce used in the encryption of the JWT token.",
"type": "string"
},
"schemaId": {
"description": "The schema id used for the data exchange.",
"type": "string"
},
"status": {
"description": "The status of the Data Source; `active` or `disabled`",
"type": "string"
},
"subject": {
"description": "Rhe subject field in the JWT token. Usually, an indication of the app's function",
"type": "string"
},
"tokenLifetimeMinutes": {
"description": "The validity of the created token in minutes. Before the token expiration time, a new token must be provided, or Webex will stop delivering data after the token expiration",
"type": "number"
},
"url": {
"description": "The URL of the endpoint where Webex will send the data.",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "OK",
"headers": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"tags": [
"Data Sources"
],
"description": "Show details for a data source, by dataSource id.\nTo see details for a data source, use the Service App token with the `spark-admin:datasource_read` scope.",
"operationId": "Retrieve Data Source Details",
"summary": "Retrieve Data Source Details"
},
"put": {
"parameters": [
{
"description": "The unique identifier for the data source.",
"example": "f29bb291-5db0-411b-834a-e64f8dee0658",
"in": "path",
"name": "dataSourceId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"audience": "MedDocVirtualAgent",
"errorMessage": "down for maintenance",
"id": "f29bb291-5db0-411b-834a-e64f8dee0658",
"nonce": "jeieu38udue83u398",
"schemaId": "78efc775-dccb-45ca-9acf-989a4a59f788",
"status": "active",
"subject": "callAudioData",
"tokenLifetimeMinutes": 60,
"url": "https://www.byods.com/service1"
}
}
},
"schema": {
"properties": {
"audience": {
"description": "The audience field in the JWT token. Usually, the DAPs app name.",
"type": "string"
},
"errorMessage": {
"description": "Error Message shown in Control Hub when status is set to `disabled`.",
"type": "string"
},
"id": {
"description": "The Data Source Id.",
"type": "string"
},
"nonce": {
"description": "Unique nonce used in the encryption of the JWT token.",
"type": "string"
},
"schemaId": {
"description": "The schema id used for the data exchange.",
"type": "string"
},
"status": {
"description": "The status of the Data Source; `active` or `disabled`",
"type": "string"
},
"subject": {
"description": "Rhe subject field in the JWT token. Usually, an indication of the app's function",
"type": "string"
},
"tokenLifetimeMinutes": {
"description": "The validity of the created token in minutes. Before the token expiration time, a new token must be provided, or Webex will stop delivering data after the token expiration",
"type": "number"
},
"url": {
"description": "The URL of the endpoint where Webex will send the data.",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "OK",
"headers": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"tags": [
"Data Sources"
],
"description": "Updates a Data Source. The updateable fields are the `audience,` `subject,` `nonce,` `url` and `tokenLifetimeMinutes.`\nYou can update the `status` from `active` to `disabled` only when providing an `errorMessage` that may be shown to the customer admin in Control Hub. \nTokens must be regularly updated before their expiration to maintain system uptime.",
"operationId": "Update a Data Source",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"audience": {
"description": "The audience field in the JWT token. Usually, the DAPs app name.",
"example": "MedDocVirtualAgent",
"type": "string"
},
"errorMessage": {
"description": "Error Message shown in Control Hub when status is set to `disabled`.",
"example": "down for maintenance",
"type": "string"
},
"nonce": {
"description": "Unique nonce used in the encryption of the JWT token.",
"example": "jeieu38udue83u398",
"type": "string"
},
"schemaId": {
"description": "The schema id used for the data exchange.",
"example": "78efc775-dccb-45ca-9acf-989a4a59f788",
"type": "string"
},
"status": {
"description": "The status of the Data Source; `active` or `disabled`.",
"example": "active",
"type": "string"
},
"subject": {
"description": "The subject field in the JWT token. Usually, an indication of the app's function",
"example": "callAudioData",
"type": "string"
},
"tokenLifetimeMinutes": {
"description": "The validity of the created token in minutes. Before the token expiration time, a new token must be provided, or Webex will stop delivering data after the token expiration. Must be equal or less to 1440.",
"example": 60,
"type": "number"
},
"url": {
"description": "The URL of the endpoint where Webex will send the data.",
"example": "https://www.byods.com/service1",
"type": "string"
}
},
"type": "object"
}
}
}
},
"summary": "Update a Data Source"
}
},
"/identity/organizations/{orgId}/v1/ArchivedUser/{useruuid}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArchiveUser"
},
"example": {
"schemas": [
"urn:scim:schemas:core:1.0",
"urn:scim:schemas:extension:cisco:commonidentity:1.0"
],
"userName": "test_user2@example.com",
"emails": [
{
"primary": true,
"type": "work",
"value": "test_user2@example.com"
}
],
"name": {
"givenName": "Mike",
"familyName": "Tang"
},
"organization": "410139c6-3bff-4404-9782-09a456ba2cae",
"id": "b96936c9-5b86-4a01-8969-e945c91b62f6",
"meta": {
"created": "2019-01-25T00:53:13.000Z",
"lastModified": "2019-01-25T00:53:13.000Z",
"location": "https://webexapis.com/identity/scim/410139c6-3bff-4404-9782-09a456ba2cae/v1/UserArchives/b96936c9-5b86-4a01-8969-e945c91b62f6",
"deleted": "2019-01-25T00:53:13.001Z"
},
"displayName": "Mike Tang"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be processed. An accompanying error message explains the issue."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or invalid."
},
"403": {
"description": "Forbidden: The request was understood but access is denied."
},
"404": {
"description": "Not Found: The requested URI is invalid, or the resource (such as a user) does not exist. Also returned when the requested format is not supported for the method."
},
"405": {
"description": "Method Not Allowed: The request was made using an unsupported HTTP method."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with an existing system rule. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may indicate how many seconds to wait before retrying."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and must be force-downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given time and the request has been rate limited. A Retry-After header indicates how many seconds to wait before retrying."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server. Try again later."
},
"503": {
"description": "Service Unavailable: The server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Archive User",
"operationId": "getArchiveUser",
"description": "The `useruuid` is the unique identifier of a user in the system. It is assigned when the user is created and can be retrieved through **GET Users** API.
\n\n**Authorization**\n\nOAuth token issued by the Identity Broker.\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`.\n- `identity:people_read`.\n\nThe following administrators can use this API:\n\n- `Account in the specified organization with one of the following roles: id_full_admin, id_user_admin, id_readonly_admin`.\n- `Proxy account managing the specified organization with one of the following roles: id_full_admin, id_user_admin, id_readonly_admin`.\n\n
",
"tags": [
"Archive Users"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The unique identifier for the organization.",
"required": true,
"example": "410139c6-3bff-4404-9782-09a456ba2cae",
"schema": {
"type": "string"
}
},
{
"name": "useruuid",
"in": "path",
"description": "The unique identifier for the user.",
"required": true,
"example": "b96936c9-5b86-4a01-8969-e945c91b62f6",
"schema": {
"type": "string"
}
}
]
}
},
"/identity/organizations/{orgId}/actions/getDomainVerificationToken": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainVerificationToken"
},
"example": {
"domain": "cisco.com",
"token": "f5014515-6559-4a30-9d68-0deb028f27b7",
"verificationMethod": "DNS_TXT",
"url": "https://identity.webex.com/organization/bf732c85-68ca-4867-94e4-937286ad2fd4/v1/actions/DomainVerification/GetToken/invoke"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Domain Verification Token",
"operationId": "Get Domain Verification Token",
"description": "This endpoint helps generate a token for a given domain within the specified organization. The user needs to add this token as a 'TXT' record to the DNS server.\n\n**Possible Error:**\n\n- 409: The request encountered a resource conflict. This error occurs if the domain is either claimed by another organization or by the same organization.\n\n**Authorization:**\n\nAn 'OAuth' token issued by the 'Identity Broker' is required to access this endpoint. The token must include one of the following scopes:\n\n- `Identity:Organization`\n\n- `identity:organizations_rw`\n\n**Administrator Roles:**\n\nThe following administrators can use this API:\n\n- `id_full_admin`",
"tags": [
"API - Domain Management"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The Webex Identity-assigned organization identifier for a user's organization.",
"required": true,
"example": "bf732c85-68ca-4867-94e4-937286ad2fd4",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"domain": "cisco.com"
},
"schema": {
"$ref": "#/components/schemas/PostDomainVerificationToken"
}
}
}
}
}
},
"/identity/organizations/{orgId}/actions/verifyDomain": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainVerification"
},
"example": {
"verifiedDomains": [
"cisco.com",
"webex.com"
],
"claimedDomains": [
"cisco.com",
"webex.com"
],
"url": "https://identity.webex.com/organization/bf732c85-68ca-4867-94e4-937286ad2fd4/v1/actions/DomainVerification/Verify/invoke"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Verify Domain",
"operationId": "Verify Domain",
"description": "This endpoint helps verify a given domain within the specified organization. This API verifies domain ownership by looking up and validating the 'TXT' record for the domain.\nOnce verified, domain enforcement will be applied to the organization. Any users in the organization whose email domain doesn't match one of the verified domains will be marked as transient.\n\nIf you want to verify and claim the domain, just set the 'claimDomain' parameter to true. By default, it's set to false, which will only verify the domain.\n\n**Possible Errors:**\n\n- 400: The request was a Bad Request. The domain can't be verified. This error happens if the user didn't request a token before trying to verify the domain.\n\n- 409: The request resulted in a resource conflict. This error occurs if the domain has already been claimed by another organization.\n\n**Authorization:**\n\nAn 'OAuth' token issued by the 'Identity Broker' is required to access this endpoint. The token must include one of the following scopes:\n\n- `Identity:Organization`\n\n- `identity:organizations_rw`\n\n**Administrator Roles:**\n\nThe following administrators can use this API:\n\n- `id_full_admin`",
"tags": [
"API - Domain Management"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The Webex Identity-assigned organization identifier for a user's organization.",
"required": true,
"example": "bf732c85-68ca-4867-94e4-937286ad2fd4",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"domain": "cisco.com",
"claimDomain": false,
"reserveDomain": false
},
"schema": {
"$ref": "#/components/schemas/PostDomainVerification"
}
}
}
}
}
},
"/identity/organizations/{orgId}/actions/claimDomain": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClaimDomain"
}
}
}
},
"example": {
"data": [
{
"domain": "cisco.com",
"url": "https://identity.webex.com/organizations/bf732c85-68ca-4867-94e4-937286ad2fd4/v1/domains/ZXhhbXBsZTMuY29t"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Claim Domain",
"operationId": "Claim Domain",
"description": "This endpoint helps claim the given domain within the specified organization. The domain needs to be verified before it can be claimed.\n\n**Note**\n\n\nThere's an organization-level boolean flag called 'enforceVerifiedDomains'. If this flag is set to false, we won't put any user in the organization into a transient state when verifying or claiming a domain.\nCustomers can still create users within the organization who don't use the verified domains as their email. However, if the flag is set to true, all users in the organization must use one of the verified domains as their email.\nThis flag defines whether the organization enforces user email verification within the organization. If set to true, all users inside the organization must use one of the verified domains.\nThis flag is effective only after the admin has verified at least one email domain.\n\n\n**Possible Error:**\n\n- 400: The request was a Bad Request. This error occurs if the domain is not verified.\n\n**Authorization:**\n\nAn 'OAuth' token issued by the 'Identity Broker' is required to access this endpoint. The token must include one of the following scopes:\n\n- `Identity:Organization`\n\n- `identity:organizations_rw`\n\n**Administrator Roles:**\n\nThe following administrators can use this API:\n\n- `id_full_admin`",
"tags": [
"API - Domain Management"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The Webex Identity-assigned organization identifier for a user's organization.",
"required": true,
"example": "bf732c85-68ca-4867-94e4-937286ad2fd4",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"data": [
{
"domain": "cisco.com"
}
],
"forceDomainClaim": true,
"claimDomainOnly": false
},
"schema": {
"$ref": "#/components/schemas/PostClaimDomain"
}
}
}
}
}
},
"/identity/organizations/{orgId}/actions/unverifyDomain": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainUnverification"
},
"example": {
"verifiedDomains": [
"cisco.com",
"webex.com"
],
"claimedDomains": [
"cisco.com",
"webex.com"
],
"url": "https://identity.webex.com/organization/bf732c85-68ca-4867-94e4-937286ad2fd4/v1/actions/DomainVerification/Unverify/invoke"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Unverify Domain",
"operationId": "Unverify Domain",
"description": "After you unclaim the domain, it will still be verified. Domain enforcement will still apply to the organization. The unverify endpoint helps to remove the domain ownership verification for the organization.\n\n**Possible Error:**\n\n- 400: The request was a Bad Request. The domain cannot be unverified. This error occurs if the domain is still claimed.\n\n- 404: The request was Not Found. This error occurs if the domain is not associated with the organization.\n\n**Authorization:**\n\nAn 'OAuth' token issued by the 'Identity Broker' is required to access this endpoint. The token must include one of the following scopes:\n\n- `Identity:Organization`\n\n- `identity:organizations_rw`\n\n**Administrator Roles:**\n\nThe following administrators can use this API:\n\n- `id_full_admin`",
"tags": [
"API - Domain Management"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The Webex Identity-assigned organization identifier for a user's organization.",
"required": true,
"example": "bf732c85-68ca-4867-94e4-937286ad2fd4",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"domain": "abc.com",
"removePending": false
},
"schema": {
"$ref": "#/components/schemas/PostDomainUnverification"
}
}
}
}
}
},
"/identity/organizations/{orgId}/actions/unclaimDomain": {
"post": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Unclaim Domain",
"operationId": "Unclaim Domain",
"description": "This API is used to unclaim a domain for the organization. The domain will remain verified, and domain enforcement will still apply to the given organization.\n\n**Possible Error:**\n\n- 400: The request was a Bad Request. The domain cannot be unclaimed. This error occurs if the requested parameter is invalid.\n\n**Authorization:**\n\nAn 'OAuth' token issued by the 'Identity Broker' is required to access this endpoint. The token must include one of the following scopes:\n\n- `Identity:Organization`\n\n- `identity:organizations_rw`\n\n**Administrator Roles:**\n\nThe following administrators can use this API:\n\n- `id_full_admin`",
"tags": [
"API - Domain Management"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The Webex Identity-assigned organization identifier for a user's organization.",
"required": true,
"example": "bf732c85-68ca-4867-94e4-937286ad2fd4",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"domain": "test.dc-01.com"
},
"schema": {
"$ref": "#/components/schemas/UnclaimDomain"
}
}
}
}
}
},
"/identity/organizations/{orgId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetOrgResponse"
},
"example": {
"schemas": [
"urn:cisco:codev:identity:organization:core:1.0"
],
"id": "82adacf4-453f-4e2b-a406-2939fddcaad2",
"displayName": "Acme, Inc.",
"meta": {
"created": "2021-05-13T15:51:09.736Z",
"lastModified": "2024-05-16T12:25:16.739Z",
"version": "W/\"67863103533\""
}
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get an organization",
"operationId": "Get an organization",
"description": "
\n\n**Authorization**\n\nOAuth token rendered by identity broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:organizations_rw`\n\n- `identity:organizations_read`\n\n
",
"tags": [
"Identity Organization"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Webex Identity assigned organization identifier.",
"required": true,
"example": "82adacf4-453f-4e2b-a406-2939fddcaad2",
"schema": {
"type": "string"
}
}
]
},
"patch": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetOrgResponse"
},
"example": {
"schemas": [
"urn:cisco:codev:identity:organization:core:1.0"
],
"id": "82adacf4-453f-4e2b-a406-2939fddcaad2",
"displayName": "Acme_New, Inc.",
"preferredLanguage": "en_US",
"meta": {
"created": "2021-05-13T15:51:09.736Z",
"lastModified": "2024-05-20T12:25:16.739Z",
"version": "W/\"67863100894\""
}
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Update an organization",
"operationId": "Update an organization",
"description": "
\n\n**Authorization**\n\nOAuth token rendered by identity broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:organizations_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n
\n\n**Usage**:\n\n1. Input JSON must contain schema: \"urn:cisco:codev:identity:organization:core:1.0\".",
"tags": [
"Identity Organization"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Webex Identity assigned organization identifier.",
"required": true,
"example": "82adacf4-453f-4e2b-a406-2939fddcaad2",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"schemas": [
"urn:cisco:codev:identity:organization:core:1.0"
],
"displayName": "Acme_New, Inc.",
"preferredLanguage": "en_US"
},
"schema": {
"$ref": "#/components/schemas/updateOrgObject"
}
}
}
}
}
},
"/identity/organizations/{orgId}/users/{userId}/actions/generateOtp": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenerateOtp"
},
"example": {
"oneTimePassword": "283489",
"expiresIn": 604800
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Generate OTP",
"operationId": "Generate OTP",
"description": "This API allows an admin to generate a One-Time Password (OTP) for user accounts with `userNameType` set as `partner-upn`. The OTP is used by users to log in to any Webex application, whereupon they are asked to change their password.\nThe OTP generated by this API has a default length of 6 digits and expires in 7 days.\n\nSeveral OTPs can be active for the same user. When the user successfully uses an OTP, all other OTPs are automatically revoked.\n\nThe creation of OTPs is logged in the [Admin Audit Events](https://developer.webex.com/docs/api/v1/admin-audit-events).\n\n**Possible Error:**\n\n- 403: The request was forbidden. OTP generation is restricted to users with a `userNameType` of `partner-upn`. This error occurs if the user does not meet the required criteria for OTP generation.\n\n**Authorization:**\n\nAn OAuth token issued by the Identity Broker is required to access this endpoint. The token must include one of the following scopes:\n\n- `Identity:one_time_password`\nor\n\n- `Identity:Config`\n\n**Administrator Roles:**\n\nThe following administrators have permission to use this API:\n\n- `Org Full Admin`: Can generate OTPs for non-email-type users in their organization.\n\n- `Partner Full Admin`: Can generate OTPs for User/Machine Accounts in Customer Orgs.\n\n- `Org User Admin`: Can generate OTPs for User/Machine Accounts within their organization.",
"tags": [
"Identity Organization"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The Webex Identity-assigned organization identifier for a user's organization.",
"required": true,
"example": "bf732c85-68ca-4867-94e4-937286ad2fd4",
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "path",
"description": "The Common Identity-assigned user identifier for an existing user (`entryUUID`).",
"required": true,
"example": "73e0e4f2-66f6-417a-b074-d473ed537f58",
"schema": {
"type": "string"
}
}
]
}
},
"/events": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Link": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventCollectionResponse"
},
"example": {
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL0VWRU5UL2JiY2ViMWFkLTQzZjEtM2I1OC05MTQ3LWYxNGJiMGM0ZDE1NAo",
"resource": "messages",
"type": "created",
"appId": "null",
"actorId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"orgId": "OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"created": "2016-05-16T21:34:59.324Z",
"data": {
"id": "Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk",
"roomId": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
"roomType": "group",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jZTg2MWZiYS02ZTJmLTQ5ZjktOWE4NC1iMzU0MDA4ZmFjOWU",
"text": "PROJECT UPDATE - A new project plan has been published on Box: http://box.com/s/lf5vj. The PM for this project is Mike C. and the Engineering Manager is Jane W.",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"personEmail": "matt@example.com",
"meetingId": "16ce696f75844d24b2d4fab04b4419af_I_183979003076423608",
"creatorId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS82YWE2ZGE5OS0xYzdlLTQ4MWItODY3YS03MWY2NTIwNDk0MzM",
"transcriptionEnabled": "yes",
"recordingEnabled": "yes",
"hasPostMeetingsChat": "yes",
"corelationId": "fdda8613-d34b-424c-8c6a-44ff2e19379c",
"callType": "SIP_ENTERPRISE",
"userId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZjEwMTU1NC04ZGJjLTQyMmUtOGEzZC1kYTk1YTI3NWZlNzU",
"userType": "User",
"callDirection": "ORIGINTATING",
"isCallAnswered": "true",
"callDurationSeconds": "192",
"callStartTime": "2023-02-08T06:12:43.976Z",
"callAnswerTime": "2023-02-08T06:12:47.012Z",
"callTransferTime": "2023-02-08T06:15:19.112Z",
"callingNumber": "910481234",
"callingLineId": "211",
"calledNumber": "4089671221",
"calledLineId": "219",
"dialedDigits": "123",
"callRedirectingNumber": "",
"callRedirectedReason": "",
"created": "2016-05-16T21:34:59.324Z",
"type": "direct",
"breakoutSessionId": "d66a4a90-4f50-11ef-bc94-f5c71646dc71",
"recipients": [
{
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lOGYwOTIwOC00ZjUxLTExZWYtOTQ4My1iYTA3NjE2MzY4NmQ",
"personEmail": "johndoe@simplistic.com",
"guestDisplayName": "John Wayne",
"guestEmail": "jwayne@mailinator.com"
}
]
}
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Events",
"operationId": "List Events",
"description": "List events in your organization. Several query parameters are available to filter the events returned in the response.\n\nLong result sets will be split into [pages](/docs/basics#pagination).",
"tags": [
"Events"
],
"parameters": [
{
"name": "resource",
"in": "query",
"description": "List events with a specific resource type.",
"example": "messages",
"schema": {
"type": "string",
"enum": [
"attachmentActions",
"businessTexts",
"call_records",
"convergedRecordings",
"file_transcodings",
"files",
"meetingMessages",
"meetings",
"meetingTranscripts",
"memberships",
"messages",
"rooms",
"tabs"
]
}
},
{
"name": "type",
"in": "query",
"description": "List events with a specific event type.",
"example": "created",
"schema": {
"type": "string",
"enum": [
"created",
"updated",
"deleted",
"ended"
]
}
},
{
"name": "actorId",
"in": "query",
"description": "List events performed by this person, by person ID.",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80MDNlZmUwNy02Yzc3LTQyY2UtOWI4NC1lZjhjYzY1ZDA4NDI",
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "List events which occurred after a specific date and time.",
"example": "2018-01-01T00:00:00.000Z",
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"description": "List events that occurred before a specific date and time. If not specified, events up to the present time will be listed. Cannot be set to a future date relative to the current time.",
"example": "2018-01-02T00:00:00.000Z",
"schema": {
"type": "string"
}
},
{
"name": "max",
"in": "query",
"description": "Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.",
"example": "100",
"schema": {
"type": "number",
"default": 100
}
},
{
"name": "serviceType",
"in": "query",
"description": "List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.",
"example": "calling",
"schema": {
"type": "string",
"enum": [
"calling"
]
}
}
]
}
},
"/events/{eventId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Event"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL0VWRU5UL2JiY2ViMWFkLTQzZjEtM2I1OC05MTQ3LWYxNGJiMGM0ZDE1NAo",
"resource": "messages",
"type": "created",
"appId": "null",
"actorId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"orgId": "OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"created": "2016-05-16T21:34:59.324Z",
"data": {
"id": "Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk",
"roomId": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
"roomType": "group",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jZTg2MWZiYS02ZTJmLTQ5ZjktOWE4NC1iMzU0MDA4ZmFjOWU",
"text": "PROJECT UPDATE - A new project plan has been published on Box: http://box.com/s/lf5vj. The PM for this project is Mike C. and the Engineering Manager is Jane W.",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"personEmail": "matt@example.com",
"meetingId": "16ce696f75844d24b2d4fab04b4419af_I_183979003076423608",
"creatorId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS82YWE2ZGE5OS0xYzdlLTQ4MWItODY3YS03MWY2NTIwNDk0MzM",
"transcriptionEnabled": "yes",
"recordingEnabled": "yes",
"hasPostMeetingsChat": "yes",
"corelationId": "fdda8613-d34b-424c-8c6a-44ff2e19379c",
"callType": "SIP_ENTERPRISE",
"userId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZjEwMTU1NC04ZGJjLTQyMmUtOGEzZC1kYTk1YTI3NWZlNzU",
"userType": "User",
"callDirection": "ORIGINTATING",
"isCallAnswered": "true",
"callDurationSeconds": "192",
"callStartTime": "2023-02-08T06:12:43.976Z",
"callAnswerTime": "2023-02-08T06:12:47.012Z",
"callTransferTime": "2023-02-08T06:15:19.112Z",
"callingNumber": "910481234",
"callingLineId": "211",
"calledNumber": "4089671221",
"calledLineId": "219",
"dialedDigits": "123",
"callRedirectingNumber": "",
"callRedirectedReason": "",
"created": "2016-05-16T21:34:59.324Z",
"type": "direct",
"breakoutSessionId": "d66a4a90-4f50-11ef-bc94-f5c71646dc71",
"recipients": [
{
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lOGYwOTIwOC00ZjUxLTExZWYtOTQ4My1iYTA3NjE2MzY4NmQ",
"personEmail": "johndoe@simplistic.com",
"guestDisplayName": "John Wayne",
"guestEmail": "jwayne@mailinator.com"
}
]
}
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Event Details",
"operationId": "Get Event Details",
"description": "Shows details for an event, by event ID.\n\nSpecify the event ID in the `eventId` parameter in the URI.",
"tags": [
"Events"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"description": "The unique identifier for the event.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL0VWRU5UL2JiY2ViMWFkLTQzZjEtM2I1OC05MTQ3LWYxNGJiMGM0ZDE1NAo",
"schema": {
"type": "string"
}
}
]
}
},
"/groups": {
"post": {
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupResponse"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvMjUxMDRiZTAtZjg3NC00MzQzLTk2MDctZGYwMmRmMzdiNWMxOjM0OGFkYjgxLTI4ZjktNGFiNS1iMmQ2LWU5YjQ5NGU3MmEwNg",
"displayName": "Sales Group",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNDhhZGI4MS0yOGY5LTRhYjUtYjJkNi1lOWI0OTRlNzJhMDY",
"created": "2022-02-17T02:13:29.706Z",
"lastModified": "2022-02-17T02:13:29.706Z",
"memberSize": 1,
"members": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xOTUzOTdhMi03MTU5LTRjNTgtYTBiOC00NmQ2ZWZlZTdkMTM",
"type": "user",
"displayName": "Jane Smith"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Create a Group",
"operationId": "Create a Group",
"description": "Create a new group for a given organization. The group may optionally be created with group members.",
"tags": [
"Groups"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"example": {
"displayName": "Sales Group",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNDhhZGI4MS0yOGY5LTRhYjUtYjJkNi1lOWI0OTRlNzJhMDY",
"description": "Salas Group in San Jose",
"members": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xOTUzOTdhMi03MTU5LTRjNTgtYTBiOC00NmQ2ZWZlZTdkMTM"
}
]
},
"schema": {
"$ref": "#/components/schemas/PostGroup"
}
}
}
}
},
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupsCollectionResponse"
},
"example": {
"totalResults": 3,
"startIndex": 1,
"itemsPerPage": 10,
"groups": [
{
"id": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvMjUxMDRiZTAtZjg3NC00MzQzLTk2MDctZGYwMmRmMzdiNWMxOjM0OGFkYjgxLTI4ZjktNGFiNS1iMmQ2LWU5YjQ5NGU3MmEwNg",
"displayName": "Sales Group",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNDhhZGI4MS0yOGY5LTRhYjUtYjJkNi1lOWI0OTRlNzJhMDY",
"created": "2022-02-17T02:13:29.706Z",
"lastModified": "2022-02-17T02:13:29.706Z",
"memberSize": 1,
"members": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xOTUzOTdhMi03MTU5LTRjNTgtYTBiOC00NmQ2ZWZlZTdkMTM",
"type": "user",
"displayName": "Jane Smith"
}
]
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List and Search Groups",
"operationId": "List and Search Groups",
"description": "List groups in your organization.\n\n* Set the `includeMembers` parameter to `true` to return group members. The total number of members returned is limited to 500.\n\n* Use the `startIndex` and `count` parameters to page through result set.\n\n* To search for a specific group use the `filter` parameter.\n\n* Use `sortBy` parameter to sort the responses by `id` or `displayName`.",
"tags": [
"Groups"
],
"parameters": [
{
"name": "orgId",
"in": "query",
"description": "List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.",
"example": "displayName eq \"Marketing Department\"",
"schema": {
"type": "string"
}
},
{
"name": "attributes",
"in": "query",
"description": "The attributes to return.",
"example": "displayName",
"schema": {
"type": "string"
}
},
{
"name": "sortBy",
"in": "query",
"description": "Sort the results based by group `displayName`.",
"example": "displayName",
"schema": {
"type": "string"
}
},
{
"name": "sortOrder",
"in": "query",
"description": "Sort results alphabetically by group display name, in ascending or descending order.",
"example": "ascending",
"schema": {
"type": "string"
}
},
{
"name": "includeMembers",
"in": "query",
"description": "Optionally return group members in the response. The maximum number of members returned is 500.",
"example": "false",
"schema": {
"type": "boolean"
}
},
{
"name": "startIndex",
"in": "query",
"description": "The index to start for group pagination.",
"example": "1",
"schema": {
"type": "number"
}
},
{
"name": "count",
"in": "query",
"description": "Specifies the desired number of search results per page.",
"example": "100",
"schema": {
"type": "number"
}
}
]
}
},
"/groups/{groupId}": {
"patch": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupResponse"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvMjUxMDRiZTAtZjg3NC00MzQzLTk2MDctZGYwMmRmMzdiNWMxOjM0OGFkYjgxLTI4ZjktNGFiNS1iMmQ2LWU5YjQ5NGU3MmEwNg",
"displayName": "Sales Group",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNDhhZGI4MS0yOGY5LTRhYjUtYjJkNi1lOWI0OTRlNzJhMDY",
"created": "2022-02-17T02:13:29.706Z",
"lastModified": "2022-02-17T02:13:29.706Z",
"memberSize": 1,
"members": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xOTUzOTdhMi03MTU5LTRjNTgtYTBiOC00NmQ2ZWZlZTdkMTM",
"type": "user",
"displayName": "Jane Smith"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Update a Group",
"operationId": "Update a Group",
"description": "Update the group details, by ID.\n\nSpecify the group ID in the `groupId` parameter in the URI.",
"tags": [
"Groups"
],
"parameters": [
{
"name": "groupId",
"in": "path",
"description": "A unique identifier for the group.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvYzY1ZjdkODUtYjY5MS00MmI4LWEyMGItODUzMDY0ZTFkNThiOjM0OGFkYjgxLTI4ZjktNGFiNS1iMmQ2LWU5YjQ5NGU3MmEwNg",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"displayName": "New Sales Group",
"description": "Sales Group in LA",
"members": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xOTUzOTdhMi03MTU5LTRjNTgtYTBiOC00NmQ2ZWZlZTdkMTM",
"operation": "add"
}
]
},
"schema": {
"$ref": "#/components/schemas/PatchGroup"
}
}
}
}
},
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupResponse"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvMjUxMDRiZTAtZjg3NC00MzQzLTk2MDctZGYwMmRmMzdiNWMxOjM0OGFkYjgxLTI4ZjktNGFiNS1iMmQ2LWU5YjQ5NGU3MmEwNg",
"displayName": "Sales Group",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNDhhZGI4MS0yOGY5LTRhYjUtYjJkNi1lOWI0OTRlNzJhMDY",
"created": "2022-02-17T02:13:29.706Z",
"lastModified": "2022-02-17T02:13:29.706Z",
"memberSize": 1,
"members": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xOTUzOTdhMi03MTU5LTRjNTgtYTBiOC00NmQ2ZWZlZTdkMTM",
"type": "user",
"displayName": "Jane Smith"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Group Details",
"operationId": "Get Group Details",
"description": "Get details for a group, by ID.\n\nOptionally, the members may be retrieved with this request. The maximum number of members returned is 500.",
"tags": [
"Groups"
],
"parameters": [
{
"name": "groupId",
"in": "path",
"description": "A unique identifier for the group.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvYzY1ZjdkODUtYjY5MS00MmI4LWEyMGItODUzMDY0ZTFkNThiOjM0OGFkYjgxLTI4ZjktNGFiNS1iMmQ2LWU5YjQ5NGU3MmEwNg",
"schema": {
"type": "string"
}
},
{
"name": "includeMembers",
"in": "query",
"description": "Include the members as part of the response.",
"example": "true",
"schema": {
"type": "boolean",
"default": "false"
}
}
]
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Delete a Group",
"operationId": "Delete a Group",
"description": "Remove a group from the system.\n\nSpecify the group ID in the `groupId` parameter in the URI.",
"tags": [
"Groups"
],
"parameters": [
{
"name": "groupId",
"in": "path",
"description": "A unique identifier for the group.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"schema": {
"type": "string"
}
}
]
}
},
"/groups/{groupId}/members": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupResponse"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvMjUxMDRiZTAtZjg3NC00MzQzLTk2MDctZGYwMmRmMzdiNWMxOjM0OGFkYjgxLTI4ZjktNGFiNS1iMmQ2LWU5YjQ5NGU3MmEwNg",
"displayName": "Sales Group",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNDhhZGI4MS0yOGY5LTRhYjUtYjJkNi1lOWI0OTRlNzJhMDY",
"created": "2022-02-17T02:13:29.706Z",
"lastModified": "2022-02-17T02:13:29.706Z",
"memberSize": 1,
"members": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xOTUzOTdhMi03MTU5LTRjNTgtYTBiOC00NmQ2ZWZlZTdkMTM",
"type": "user",
"displayName": "Jane Smith"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Group Members",
"operationId": "Get Group Members",
"description": "Gets the members of a group.\n\n* The default maximum members returned is 500.\n\n* Control parameters is available to page through the members and to control the size of the results.",
"tags": [
"Groups"
],
"parameters": [
{
"name": "groupId",
"in": "path",
"description": "A unique identifier for the group.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvYzY1ZjdkODUtYjY5MS00MmI4LWEyMGItODUzMDY0ZTFkNThiOjM0OGFkYjgxLTI4ZjktNGFiNS1iMmQ2LWU5YjQ5NGU3MmEwNg",
"schema": {
"type": "string"
}
},
{
"name": "startIndex",
"in": "query",
"description": "The index to start for group pagination.",
"example": "1",
"schema": {
"type": "number"
}
},
{
"name": "count",
"in": "query",
"description": "Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.",
"example": "100",
"schema": {
"type": "number"
}
}
]
}
},
"/guests/token": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Guest"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zNzlhNWQ4ZC1hNTE4LTQ3NmQtYmY1NC1mZmE5MWQ3OWM4MTI",
"subject": "PersonNo#1",
"displayName": "Person of Interest",
"email": "1ad14c30-59a6-31a7-b345-963e3d167e10@appid.ciscospark.com",
"accessToken": "eyJhbGciOiJSUzI1NiJ9.eyJkw1zx5iIDv7FL3cWQ_JEjehqtPVRmFf572q7RZwSIZgQRziAw",
"expiresIn": 64799
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Create a Guest",
"operationId": "Create a Guest",
"description": "Create a new token for a single guest user. The Service App that creates the guest must have the scope `guest-issuer:write`.\n\nGuests are implicitly created by retrieving the guest access token.\n\nRepeated calls to this API with the same `subject` will create additional tokens without invalidating previous ones. Tokens are valid until the `expiresIn`.\n\nGuests can be renamed by supplying the same `subject` and changing the `displayName.`\n\nTo retrieve a new token for an existing guest, please provide the existing guest's `subject`. Tokens are valid until `expiresIn`.",
"tags": [
"Guest Management"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"subject",
"displayName"
],
"properties": {
"subject": {
"type": "string",
"example": "ExternalGuestIdentifier",
"description": "The unique and external identifier of the guest."
},
"displayName": {
"type": "string",
"example": "John Doe",
"description": "The display name shown in the Webex application."
}
}
}
}
}
}
}
},
"/guests/count": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "object",
"properties": {
"112": {
"type": "number",
"description": "the number of guests"
}
}
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Guest Count",
"operationId": "Get Guest Count",
"description": "To retrieve the number of guests, the scopes `guest-issuer:read` or `guest-issuer:write` are needed.",
"tags": [
"Guest Management"
],
"parameters": []
}
},
"/v1/analytics/messagingMetrics/dailyTotals": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"example": "2020-08-01",
"description": "UTC start date of the data set."
},
"endDate": {
"type": "string",
"example": "2020-08-03",
"description": "UTC end date of the data set."
},
"metrics": {
"type": "object",
"properties": {
"dates": {
"type": "string",
"example": "['2020-08-01','2020-08-02']",
"description": "An Array containing the UTC dates for which the data is returned."
},
"dailyActiveUsers": {
"type": "string",
"example": "[200, 300]",
"description": "An array containing the aggregated values for each day for which the data is returned."
},
"totalMessagesSent": {
"type": "string",
"example": "[2000, 3000]"
},
"deskTopMessagesSent": {
"type": "string",
"example": "[289, 456]"
},
"mobileMessagesSent": {
"type": "string",
"example": "[122, 233]"
},
"totalActiveSpaces": {
"type": "string",
"example": "[2,3]"
},
"groupActiveSpaces": {
"type": "string",
"example": "[3,4]"
},
"one2oneActiveSpaces": {
"type": "string",
"example": "[5,6]"
},
"video": {
"type": "string"
},
"sharing": {
"type": "object",
"properties": {
"totalFilesShared": {
"type": "string",
"example": "[1,2]"
},
"fileShareSize": {
"type": "string",
"example": "`[6,7]` ## Bytes"
}
}
},
"recording": {
"type": "string"
},
"audio": {
"type": "string"
}
}
}
}
},
"example": {
"startDate": "2020-08-01",
"endDate": "2020-08-03",
"metrics": {
"dates": "['2020-08-01','2020-08-02']",
"dailyActiveUsers": "[200, 300]",
"totalMessagesSent": "[2000, 3000]",
"deskTopMessagesSent": "[289, 456]",
"mobileMessagesSent": "[122, 233]",
"totalActiveSpaces": "[2,3]",
"groupActiveSpaces": "[3,4]",
"one2oneActiveSpaces": "[5,6]",
"video": "",
"sharing": {
"totalFilesShared": "[1,2]",
"fileShareSize": "`[6,7]` ## Bytes"
},
"recording": "",
"audio": ""
}
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Historical Data related to Messaging",
"operationId": "Historical Data related to Messaging",
"description": "Returns daily aggregates of various metrics related to Webex messaging.\n\nThe base URL for these APIs is **analytics.webexapis.com**, which does not work with the **Try It** feature.
",
"tags": [
"Historical Analytics APIs"
],
"parameters": [
{
"name": "from",
"in": "query",
"description": "UTC date starting from which the data needs to be returned.",
"example": "2020-08-01",
"schema": {
"type": "string",
"default": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned."
}
},
{
"name": "to",
"in": "query",
"description": "UTC date up to which the data needs to be returned",
"example": "2020-08-03",
"schema": {
"type": "string",
"default": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned. Yesterday's data would be the latest data returned."
}
}
]
}
},
"/v1/analytics/roomDeviceMetrics/dailyTotals": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"example": "2020-08-01",
"description": "Data is returned starting from this UTC date."
},
"endDate": {
"type": "string",
"example": "2020-08-03",
"description": "Data is returned up to this UTC date."
},
"metrics": {
"type": "object",
"properties": {
"dates": {
"type": "string",
"example": "['2020-08-01','2020-08-02']",
"description": "An Array containing the UTC dates for which the data is returned"
},
"totalActiveDevices": {
"type": "string",
"example": "[200,300]",
"description": "An array containing the aggregated values for each day for which the data is returned."
},
"totalAssistantCommands": {
"type": "string",
"example": "[2,3]"
},
"totalUsageHours": {
"type": "string",
"example": "[100,100]"
},
"incallUsageDuration": {
"type": "string",
"example": "[50,50]"
},
"signageUsageDuration": {
"type": "string",
"example": "[1,1]"
},
"usbpassthroughUsageDuration": {
"type": "string",
"example": "[1,2]"
},
"whiteboardingUsageDuration": {
"type": "string",
"example": "[3,4]"
},
"video": {
"type": "string"
},
"sharing": {
"type": "object",
"properties": {
"localsharingcableUsageDuration": {
"type": "string",
"example": "[1,1]"
},
"localsharingwirelessUsageDuration": {
"type": "string",
"example": "[2,2]"
}
}
},
"recording": {
"type": "string"
},
"audio": {
"type": "string"
}
}
}
}
},
"example": {
"startDate": "2020-08-01",
"endDate": "2020-08-03",
"metrics": {
"dates": "['2020-08-01','2020-08-02']",
"totalActiveDevices": "[200,300]",
"totalAssistantCommands": "[2,3]",
"totalUsageHours": "[100,100]",
"incallUsageDuration": "[50,50]",
"signageUsageDuration": "[1,1]",
"usbpassthroughUsageDuration": "[1,2]",
"whiteboardingUsageDuration": "[3,4]",
"video": "",
"sharing": {
"localsharingcableUsageDuration": "[1,1]",
"localsharingwirelessUsageDuration": "[2,2]"
},
"recording": "",
"audio": ""
}
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Historical Data related to Room Devices",
"operationId": "Historical Data related to Room Devices",
"description": "Returns daily aggregates of various metrics related to Room Devices.\n\nThe base URL for these APIs is **analytics.webexapis.com**, which does not work with the **Try It** feature.
",
"tags": [
"Historical Analytics APIs"
],
"parameters": [
{
"name": "from",
"in": "query",
"description": "Starting UTC Date from which historical data should be returned.",
"example": "2020-08-01",
"schema": {
"type": "string",
"default": "Data related to the date specified in 'to' if 'from' is not provided. If neither 'from' nor 'to' are provided then yesterday's data is returned."
}
},
{
"name": "to",
"in": "query",
"description": "Ending UTC Date for which data should be returned.",
"example": "2020-08-03",
"schema": {
"type": "string",
"default": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the latest day the data series will contain."
}
}
]
}
},
"/v1/analytics/meetingsMetrics/aggregates": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"siteUrl": {
"type": "string",
"example": "cisco.webex.com",
"description": "Site related to which the data is returned."
},
"startDate": {
"type": "string",
"example": "2020-08-01",
"description": "UTC start date of the data set."
},
"endDate": {
"type": "string",
"example": "2020-08-03",
"description": "UTC end date of the data set."
},
"metrics": {
"type": "object",
"properties": {
"totalMeetings": {
"type": "number",
"example": 123,
"description": "Total number of meetings held over the selected date range. includes Webex Meetings, Webex Events, Webex Support, and Webex Training sessions"
},
"totalParticipants": {
"type": "number",
"example": 123,
"description": "Total number of joins by participant and devices from all Webex meetings over the selected date range"
},
"totalUniqueHosts": {
"type": "number",
"example": 123,
"description": "Total number of unique hosts who started at least one webex meeting over the selected date range"
},
"totalMeetingMinutes": {
"type": "number",
"example": 1234,
"description": "Total number of minutes for all meetings over selected date range"
},
"totalAudioMinutes": {
"type": "number",
"example": 1234,
"description": "Total number of VoIP and telephony minutes used during meetings over the selected date range"
},
"totalTelephoneMinutes": {
"type": "number",
"example": 1234
},
"totalVoIPMinutes": {
"type": "number",
"example": 1234
},
"videoMeetings": {
"type": "number",
"example": 123,
"description": "Total number of meetings held where at least one participant enabled video for any amount of time"
},
"sharingMeetings": {
"type": "number",
"example": 123,
"description": "Total number of meetings held where at least one participant enabled sharing for any amount of time"
},
"recordingMeetings": {
"type": "number",
"example": 123,
"description": "Total number of meetings held where at least one participant enable recording for any amount of time"
},
"participantsByJoinMethods": {
"type": "object",
"properties": {
"webApp": {
"type": "number",
"example": 123
},
"cloudVideoDevice": {
"type": "number",
"example": 123
},
"mobileMeetingsApp": {
"type": "number",
"example": 123
}
},
"description": "Participant Count for each join/client type. This list is dynamic and can change"
},
"participantsByRoles": {
"type": "object",
"properties": {
"host": {
"type": "number",
"example": 123
},
"attendee": {
"type": "number",
"example": 123
}
},
"description": "Participant Count for each Role"
},
"participantsByLocation": {
"type": "array",
"items": {
"type": "object",
"properties": {
"country": {
"type": "string",
"example": "United States"
},
"totalParticipants": {
"type": "number",
"example": 123
}
}
},
"description": "Participant Count for each Location. This is a json array of countries"
}
}
}
}
},
"example": {
"siteUrl": "cisco.webex.com",
"startDate": "2020-08-01",
"endDate": "2020-08-03",
"metrics": {
"totalMeetings": 123,
"totalParticipants": 123,
"totalUniqueHosts": 123,
"totalMeetingMinutes": 1234,
"totalAudioMinutes": 1234,
"totalTelephoneMinutes": 1234,
"totalVoIPMinutes": 1234,
"videoMeetings": 123,
"sharingMeetings": 123,
"recordingMeetings": 123,
"participantsByJoinMethods": {
"webApp": 123,
"cloudVideoDevice": 123,
"mobileMeetingsApp": 123
},
"participantsByRoles": {
"host": 123,
"attendee": 123
},
"participantsByLocation": [
{
"country": "United States",
"totalParticipants": 123
}
]
}
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Historical Data related to Meetings",
"operationId": "Historical Data related to Meetings",
"description": "Return aggregates of various metrics related to meetings for a given Webex site over a specified time range.\n\nThe base URL for these APIs is **analytics.webexapis.com**, which does not work with the **Try It** feature.
",
"tags": [
"Historical Analytics APIs"
],
"parameters": [
{
"name": "siteUrl",
"in": "query",
"description": "URL of the Webex site for which historical data is requested.",
"required": true,
"example": "cisco.webex.com",
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "UTC Date starting from which the data needs to be returned",
"example": "2020-08-01",
"schema": {
"type": "string",
"default": "Data related to the date mentioned in 'to' parameter if 'from' parameter is not provided. Yesterday's data if neither 'from' nor 'to' are provided"
}
},
{
"name": "to",
"in": "query",
"description": "UTC Date up to which the data needs to be returned",
"example": "2020-08-03",
"schema": {
"type": "string",
"default": "Data from the date mentioned in 'from' parameter up to yesterday if 'to' parameter is not provided. Yesterday's data is returned if neither 'from' nor 'to' are provided. Yesterday is the earliest date for which there will be results."
}
}
]
}
},
"/hybrid/clusters": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClusterCollection"
},
"example": {
"items": [
{
"id": "Y2lZY76123abbb",
"orgId": "Y2lzY29zcGFyazovL3",
"name": "EMEA Oslo 1",
"resourceGroupId": "Y2lzY29zcGFyazovL3"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Hybrid Clusters",
"operationId": "List Hybrid Clusters",
"description": "List hybrid clusters for an organization. If no `orgId` is specified, the default is the organization of the authenticated user.\n\nOnly an admin auth token with the `spark-admin:hybrid_clusters_read` scope can list clusters.",
"tags": [
"Hybrid Clusters"
],
"parameters": [
{
"name": "orgId",
"in": "query",
"description": "List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"schema": {
"type": "string"
}
}
]
}
},
"/hybrid/clusters/{hybridClusterId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cluster"
},
"example": {
"id": "Y2lZY76123abbb",
"orgId": "Y2lzY29zcGFyazovL3",
"name": "EMEA Oslo 1",
"resourceGroupId": "Y2lzY29zcGFyazovL3"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Hybrid Cluster Details",
"operationId": "Get Hybrid Cluster Details",
"description": "Shows details for a hybrid cluster, by ID.\n\nOnly an admin auth token with the `spark-admin:hybrid_clusters_read` scope can see cluster details.",
"tags": [
"Hybrid Clusters"
],
"parameters": [
{
"name": "hybridClusterId",
"in": "path",
"description": "The ID of the cluster.",
"required": true,
"example": "Y2lZY76123abbb",
"schema": {
"type": "string"
}
},
{
"name": "orgId",
"in": "query",
"description": "\nFind the cluster in this specific organization.\nIf this is not specified, the organization of the caller\nwill be used.\n",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"schema": {
"type": "string"
}
}
]
}
},
"/hybrid/connectors": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorCollection"
},
"example": {
"items": [
{
"id": "Y2lZY76123",
"orgId": "Y2lzY29zcGFyazovL3",
"hybridClusterId": "Y2lZY76123abbb",
"hostname": "foo.example.org",
"status": "operational",
"created": "2017-09-15T15:53:00Z",
"type": "calendar",
"version": "1.9_foo_zz",
"alarms": [
{
"id": "Y2lZY76123af234bbYY",
"created": "2017-09-15T15:53:00Z",
"severity": "warning",
"title": "Something is wrong",
"description": "More detail about something being wrong",
"hybridConnectorId": "Y2lZY76123af234bb"
}
]
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Hybrid Connectors",
"operationId": "List Hybrid Connectors",
"description": "List hybrid connectors for an organization. If no `orgId` is specified, the default is the organization of the authenticated user.\n\nOnly an admin auth token with the `spark-admin:hybrid_connectors_read` scope can list connectors.",
"tags": [
"Hybrid Connectors"
],
"parameters": [
{
"name": "orgId",
"in": "query",
"description": "List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"schema": {
"type": "string"
}
}
]
}
},
"/hybrid/connectors/{connectorId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Connector"
},
"example": {
"id": "Y2lZY76123",
"orgId": "Y2lzY29zcGFyazovL3",
"hybridClusterId": "Y2lZY76123abbb",
"hostname": "foo.example.org",
"status": "operational",
"created": "2017-09-15T15:53:00Z",
"type": "calendar",
"version": "1.9_foo_zz",
"alarms": [
{
"id": "Y2lZY76123af234bbYY",
"created": "2017-09-15T15:53:00Z",
"severity": "warning",
"title": "Something is wrong",
"description": "More detail about something being wrong",
"hybridConnectorId": "Y2lZY76123af234bb"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Hybrid Connector Details",
"operationId": "Get Hybrid Connector Details",
"description": "Shows details for a hybrid connector, by ID.\n\nOnly an admin auth token with the `spark-admin:hybrid_connectors_read` scope can see connector details.",
"tags": [
"Hybrid Connectors"
],
"parameters": [
{
"name": "connectorId",
"in": "path",
"description": "The ID of the connector.",
"required": true,
"example": "Y2lZY76123",
"schema": {
"type": "string"
}
}
]
}
},
"/licenses": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseCollectionResponse"
},
"example": {
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"name": "Meeting - Webex Meeting Center",
"totalUnits": 50,
"consumedUnits": 5,
"consumedByUsers": 5,
"consumedByWorkspaces": 0,
"subscriptionId": "Sub-hydraOct26a",
"siteUrl": "site1-example.webex.com",
"siteType": "Control Hub managed site"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Licenses",
"operationId": "List_Licenses",
"description": "List all licenses for a given organization. If no `orgId` is specified, the default is the organization of the authenticated user.\n\nResponse properties that are not applicable to the license will not be present in the response.",
"tags": [
"Licenses"
],
"parameters": [
{
"name": "orgId",
"in": "query",
"description": "List licenses for this organization.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"schema": {
"type": "string"
}
}
]
}
},
"/licenses/{licenseId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Link": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicensewithUsers"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"name": "Meeting - Webex Meeting Center",
"totalUnits": 50,
"consumedUnits": 5,
"consumedByUsers": 5,
"consumedByWorkspaces": 0,
"subscriptionId": "Sub-hydraOct26a",
"siteUrl": "site1-example.webex.com",
"siteType": "Control Hub managed site",
"users": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"type": "INTERNAL",
"displayName": "John Andersen",
"email": "john.andersen@example.com"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get License Details",
"operationId": "Get_License_Details",
"description": "Shows details for a license, by ID.\n\nSpecify the license ID in the `licenseId` parameter in the URI.\nUse the optional query parameter `includeAssignedTo` to get a list of all objects that are assigned with the license. The objects include but not limited to, users including external users. Long result sets will be split into [pages](/docs/basics#pagination).\n\nResponse properties that are not applicable to the license will not be present in the response.",
"tags": [
"Licenses"
],
"parameters": [
{
"name": "licenseId",
"in": "path",
"description": "The unique identifier for the license.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"schema": {
"type": "string"
}
},
{
"name": "includeAssignedTo",
"in": "query",
"description": "The type of object to whom the license is assigned to.",
"example": "user",
"schema": {
"type": "string",
"enum": [
"user"
]
}
},
{
"name": "next",
"in": "query",
"description": "List the next set of users. Applicable only if `includeAssignedTo` is populated.",
"example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0VfVVNFUl9QQUdJTkcvT1RaaFltTXlZV0V0TTJSall5MHhNV1UxTFdFeE5USXRabVV6TkRneE9XTmtZemxo",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.",
"example": 0,
"schema": {
"type": "number",
"default": 300
}
}
]
}
},
"/licenses/users": {
"patch": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserLicensesResponse"
},
"example": {
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"email": "john.andersen@example.com",
"licenses": [
"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi",
"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LTIzNDItMGY0NTU2YWRlZXJm"
],
"siteUrls": [
{
"siteUrl": "mysite.webex.com",
"accountType": "attendee"
},
{
"siteUrl": "myhostsite.webex.com",
"accountType": "host"
}
]
}
}
}
},
"206": {
"description": "Partial Content: Some licenses were successfully assigned, but others could not be assigned due to various constraints or errors. Compare the returned licenses with the requested licenses to determine which ones failed.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserLicensesResponse"
},
"example": {
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"email": "john.andersen@example.com",
"licenses": [
"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh"
],
"siteUrls": [
{
"siteUrl": "mysite.webex.com",
"accountType": "attendee"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. Specific error codes indicate license assignment issues.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseError"
},
"examples": {
"locationNotFound": {
"summary": "Location not found",
"value": {
"message": "Unable to find location",
"errors": [
{
"errorCode": 400,
"description": "Unable to find location."
}
],
"trackingId": "NA_88b8b4ce-6338-4d3a-8d6c-22b37e62354f"
}
},
"licenseNotRecognized": {
"summary": "License not recognized",
"value": {
"message": "License not recognized",
"errors": [
{
"errorCode": 400000,
"description": "License not recognized {licenses}"
}
],
"trackingId": "NA_88b8b4ce-6338-4d3a-8d6c-22b37e62354f"
}
},
"callingLicenseDowngrade": {
"summary": "Webex Calling license downgrade not allowed",
"value": {
"message": "License assignment failed",
"errors": [
{
"errorCode": 400112,
"description": "Changing a user's Webex Calling license from Professional to Standard is not allowed. The following license(s) could not be applied as requested: {licenses}"
}
],
"trackingId": "NA_88b8b4ce-6338-4d3a-8d6c-22b37e62354f"
}
},
"messengerLicenseManagement": {
"summary": "Messenger license management not supported",
"value": {
"message": "License management not supported",
"errors": [
{
"errorCode": 400118,
"description": "User management of Messenger license {licenses} is not supported"
}
],
"trackingId": "NA_88b8b4ce-6338-4d3a-8d6c-22b37e62354f"
}
},
"invalidSiteUrl": {
"summary": "Invalid attendee site URLs",
"value": {
"message": "Invalid site URL",
"errors": [
{
"errorCode": 400216,
"description": "Request contains invalid attendee siteUrls: {siteUrl}"
}
],
"trackingId": "NA_88b8b4ce-6338-4d3a-8d6c-22b37e62354f"
}
},
"conflictingCallingLicenses": {
"summary": "Conflicting Webex Calling licenses",
"value": {
"message": "License conflict",
"errors": [
{
"errorCode": 400404,
"description": "User cannot have both Webex Calling Professional and Standard License together. The following license(s) could not be applied as requested: {licenses}"
}
],
"trackingId": "NA_88b8b4ce-6338-4d3a-8d6c-22b37e62354f"
}
},
"callingStandardAttendantConflict": {
"summary": "Webex Calling Standard and Attendant Console conflict",
"value": {
"message": "License conflict",
"errors": [
{
"errorCode": 400406,
"description": "User cannot have both Webex Calling Standard and Webex Attendant Console licenses together. The following license(s) could not be applied as requested: {licenses}"
}
],
"trackingId": "NA_88b8b4ce-6338-4d3a-8d6c-22b37e62354f"
}
},
"callingStandardCXEssentialConflict": {
"summary": "Webex Calling Standard and CX Essential conflict",
"value": {
"message": "License conflict",
"errors": [
{
"errorCode": 400407,
"description": "User cannot have both Webex Calling Standard and CX Essential licenses together. The following license(s) could not be applied as requested: {licenses}"
}
],
"trackingId": "NA_88b8b4ce-6338-4d3a-8d6c-22b37e62354f"
}
},
"attendantConsolePrerequisite": {
"summary": "Webex Attendant Console prerequisite missing",
"value": {
"message": "License prerequisite missing",
"errors": [
{
"errorCode": 400408,
"description": "User needs Webex Calling Professional license to be assigned before assigning Webex Attendant Console: {licenses}"
}
],
"trackingId": "NA_88b8b4ce-6338-4d3a-8d6c-22b37e62354f"
}
},
"cxEssentialDowngrade": {
"summary": "CX Essential to Webex Calling Standard downgrade not allowed",
"value": {
"message": "License downgrade not allowed",
"errors": [
{
"errorCode": 400410,
"description": "Changing a user's license from CX Essential to Webex Calling Standard is not allowed. The following license(s) could not be applied as requested: {licenses}"
}
],
"trackingId": "NA_88b8b4ce-6338-4d3a-8d6c-22b37e62354f"
}
},
"missingCallingProperties": {
"summary": "Missing calling properties",
"value": {
"message": "License properties missing",
"errors": [
{
"errorCode": 400411,
"description": "Each Webex Calling license should contain its own calling properties. The following license(s) do not have properties: {licenses}"
}
],
"trackingId": "NA_88b8b4ce-6338-4d3a-8d6c-22b37e62354f"
}
},
"exclusiveLicenseConflict": {
"summary": "Exclusive license conflict",
"value": {
"message": "License conflict",
"errors": [
{
"errorCode": 400413,
"description": "Could not apply the following license(s): {licenses} as the user can be assigned only one of licenses with the offer code from the list:"
}
],
"trackingId": "NA_88b8b4ce-6338-4d3a-8d6c-22b37e62354f"
}
},
"freeMessagingPrerequisite": {
"summary": "Free teams messaging prerequisite for paid messaging",
"value": {
"message": "License prerequisite missing",
"errors": [
{
"errorCode": 700003,
"description": "Free teams messaging mandatory for paid teams messaging license. The following license could not be applied as requested: {licenses}"
}
],
"trackingId": "NA_88b8b4ce-6338-4d3a-8d6c-22b37e62354f"
}
},
"freeMeetingPrerequisite": {
"summary": "Free teams meeting prerequisite for paid meeting",
"value": {
"message": "License prerequisite missing",
"errors": [
{
"errorCode": 700004,
"description": "Free teams meeting mandatory for paid teams meeting license. The following license could not be applied as requested: {licenses}"
}
],
"trackingId": "NA_88b8b4ce-6338-4d3a-8d6c-22b37e62354f"
}
},
"messagingPrerequisiteForMeeting": {
"summary": "Free teams messaging prerequisite for meeting",
"value": {
"message": "License prerequisite missing",
"errors": [
{
"errorCode": 700005,
"description": "Free teams messaging mandatory for teams meeting license. The following license(s) could not be applied as requested: {licenses}"
}
],
"trackingId": "NA_88b8b4ce-6338-4d3a-8d6c-22b37e62354f"
}
},
"screenShareImplicit": {
"summary": "Screen Share license cannot be removed",
"value": {
"message": "License removal not allowed",
"errors": [
{
"errorCode": 700006,
"description": "Screen Share {licenses} is implicitly assigned and cannot be removed"
}
],
"trackingId": "NA_88b8b4ce-6338-4d3a-8d6c-22b37e62354f"
}
}
}
}
}
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Assign Licenses to Users",
"operationId": "Assign_Licenses_to_Users",
"description": "Assign licenses and attendee `siteUrls` to existing users. Only an admin can assign licenses. Only existing users can be assigned a license. Assign meeting licenses to users outside your organization (Status will be pending until the user accepts the invite)\n\nAt least one of the following body parameters is required to assign license to the user: `email`, `personId`. For Calling license assignment, properties `phoneNumber` or `extension` are required. If `phoneNumber` is not provided then `locationId` is mandatory.\n\nWhen assigning licenses and attendee siteUrls to a user who does not belong to the organization, the licenses and siteUrls remain in pending state until the user accepts them. The `pendingLicenses` and `pendingSiteUrls` are part of the response.",
"tags": [
"Licenses"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"example": {
"email": "john.andersen@example.com",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"licenses": [
{
"id": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"operation": "add",
"properties": {
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"phoneNumber": "+14085267209",
"extension": "133"
}
},
{
"id": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LTU2eTctMGY0NTU2YWRleWhu",
"operation": "remove"
},
{
"id": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LTIzNDItMGY0NTU2YWRlZXJm",
"operation": "add"
}
],
"siteUrls": [
{
"siteUrl": "mysite.webex.com",
"accountType": "attendee",
"operation": "add"
}
]
},
"schema": {
"$ref": "#/components/schemas/PatchUserLicenses"
}
}
}
}
}
},
"/livemonitoring/liveMeetingsByCountry": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Link": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LivemeetingByCountryResponse"
},
"example": {
"siteUrls": [
"cisco.webex.com"
],
"totalLiveMeetingCount": 3,
"totalLiveParticipantCount": 10,
"totalGoodQualityLiveMeetingCount": 3,
"totalGoodQualityLiveParticipantCount": 10,
"totalBadQualityMeetingCount": 0,
"totalBadQualityParticipantCount": 0,
"locations": [
{
"badQualityLiveMeetingCount": 0,
"badQualityLiveParticipantCount": 0,
"goodQualityLiveMeetingCount": 1,
"goodQualityLiveParticipantCount": 3,
"country": "South Korea",
"countryLatitude": 37.55,
"countryLongitude": 126.98333,
"liveMeetingCount": 1,
"liveParticipantCount": 3
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Live Meeting metrics categorized by Country",
"operationId": "getLiveMeetingMetricsByCountry",
"description": "Retrieve live meeting metrics categorized by country for a specific meeting site or for all meeting sites owned by the customer. \n\nTo retrieve live monitoring information, you must use an administrator token with the `analytics:read_all` [scope](/docs/integrations#scopes). The authenticated user must be a read-only or full administrator of the organization to which the meeting belongs and must not be an external administrator.\n\nTo use this endpoint, the org needs to be licensed for the Webex Pro Pack.\n\nA rate limit of one API call per minute applies to each customer organization",
"tags": [
"Live Monitoring"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LivemeetingByCountryRequestBody"
}
}
}
}
}
},
"/meeting/qualities": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Link": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MeetingQualitiesResponse"
},
"example": {
"items": [
{
"meetingInstanceId": "e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470",
"webexUserName": "John Andersen",
"webexUserEmail": "john.andersen@example.com",
"joinTime": "2020-04-10T17:00:00.000Z",
"leaveTime": "2020-04-10T17:02:00.000Z",
"joinMeetingTime": "5.793",
"clientType": "Teams_Mobile_Client (iOS)",
"clientVersion": "40.5.0.210",
"osType": "mac",
"osVersion": "Version 10.14.6 (Build 18G3020)",
"hardwareType": "mac book",
"speakerName": "MacBook Pro Speakers",
"networkType": "wifi",
"localIP": "10.24.72.54",
"publicIP": "10.24.72.54",
"maskedLocalIP": "10.24.72.54",
"maskedPublicIP": "10.24.72.54",
"camera": "FaceTime HD Camera",
"microphone": "External Microphone",
"serverRegion": "San Jose, USA",
"videoMeshCluster": "Mesh Cluster One",
"videoMeshServer": "server.example.com",
"participantId": "8635cbf0ca1a4573b27348e560679b25_I_158174534545967299_57",
"participantSessionId": "3324C9D0-9EA7-45A2-B249-5B62A384AFEF",
"videoIn": [
{
"samplingInterval": 60,
"startTime": "2020-04-10T17:00:00.000Z",
"endTime": "2020-04-10T18:00:00.000Z",
"packetLoss": [],
"latency": [],
"resolutionHeight": [],
"frameRate": [
25.940001
],
"mediaBitRate": [],
"codec": "H.264 BP",
"jitter": [
170
],
"transportType": "UDP"
}
],
"videoOut": [
{
"samplingInterval": 60,
"startTime": "2020-04-10T17:00:00.000Z",
"endTime": "2020-04-10T18:00:00.000Z",
"packetLoss": [],
"latency": [],
"resolutionHeight": [],
"frameRate": [
25.940001
],
"mediaBitRate": [],
"codec": "H.264 BP",
"jitter": [],
"transportType": "UDP"
}
],
"audioIn": [
{
"samplingInterval": 60,
"startTime": "2020-04-10T17:00:00.000Z",
"endTime": "2020-04-10T18:00:00.000Z",
"packetLoss": [],
"latency": [],
"resolutionHeight": [],
"frameRate": [
25.940001
],
"mediaBitRate": [],
"codec": "Opus",
"jitter": [],
"transportType": "UDP"
}
],
"audioOut": [
{
"samplingInterval": 60,
"startTime": "2020-04-10T17:00:00.000Z",
"endTime": "2020-04-10T18:00:00.000Z",
"packetLoss": [],
"latency": [],
"resolutionHeight": [],
"frameRate": [
25.940001
],
"mediaBitRate": [],
"codec": "Opus",
"jitter": [],
"transportType": "UDP"
}
],
"shareIn": [
{
"samplingInterval": 60,
"startTime": "2020-04-10T17:00:00.000Z",
"endTime": "2020-04-10T18:00:00.000Z",
"packetLoss": [],
"latency": [],
"resolutionHeight": [],
"frameRate": [
25.940001
],
"mediaBitRate": [],
"codec": "H.264 BP",
"jitter": [],
"transportType": "UDP"
}
],
"shareOut": [
{
"samplingInterval": 60,
"startTime": "2020-04-10T17:00:00.000Z",
"endTime": "2020-04-10T18:00:00.000Z",
"packetLoss": [],
"latency": [],
"resolutionHeight": [],
"frameRate": [
25.940001
],
"mediaBitRate": [],
"codec": "H.264 BP",
"jitter": [],
"transportType": "UDP"
}
],
"resources": [
{
"processAverageCPU": [],
"processMaxCPU": [],
"systemAverageCPU": [],
"systemMaxCPU": []
}
]
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Meeting Qualities",
"operationId": "getMeetingQualities",
"description": "Get quality data for a meeting, by `meetingId`. Only organization administrators can retrieve meeting quality data.",
"tags": [
"Meeting Qualities"
],
"parameters": [
{
"name": "meetingId",
"in": "query",
"description": "Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.",
"required": true,
"example": "e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470",
"schema": {
"type": "string"
}
},
{
"name": "max",
"in": "query",
"description": "Limit the maximum number of media sessions in the response.",
"example": 100,
"schema": {
"type": "number",
"default": 100
}
},
{
"name": "offset",
"in": "query",
"description": "Offset from the first result that you want to fetch.",
"example": 0,
"schema": {
"type": "number"
}
}
]
}
},
"/contacts/organizations/{orgId}/contacts": {
"post": {
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactResponse"
},
"example": {
"schemas": "urn:cisco:codev:identity:contact:core:1.0",
"meta": {
"created": "2023-05-10T09:24:44.910Z",
"lastModified": "2023-05-10T09:24:44.910Z"
},
"contactId": "933de120-ad46-49b0-91cc-65c3966bb14e",
"firstName": "Simic",
"lastName": "Zhang",
"companyName": "Cisco Systems",
"title": "Product Manager",
"address": "{\"city\" : \"Milpitas\", \"country\" : \"US\", \"street\" : \"1099 Bird Ave.\", \"zipCode\" : \"99212\"}",
"avatarURL": "https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600",
"displayName": "Logan",
"addressInfo": {
"city": "Milpitas",
"country": "US",
"street": "1099 Bird Ave.",
"zipCode": "99212"
},
"primaryContactMethod": "EMAIL",
"phoneNumbers": [
{
"type": "work",
"value": "20134319"
}
],
"emails": [
{
"type": "work",
"value": "simizhan@example.com"
}
],
"sipAddresses": [
{
"type": "work",
"value": "sip://mysip1231233"
}
],
"ims": [
{
"type": "work",
"value": "87003922"
}
],
"source": "CH",
"isMigration": false,
"orgId": "153ced48-d2d1-4369-86fd-9b9fade218ff",
"groupIds": [
"b3e594aa-19ea-488a-9d42-f811e272f4bd"
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Create a Contact",
"operationId": "Create a Contact",
"description": "Creating a new contact for a given organization requires an org admin role.\n\nAt least one of the following body parameters: `phoneNumbers`, `emails`, `sipAddresses` is required to create a new contact for source \"CH\",\n`displayName` is required to create a new contact for source \"Webex4Broadworks\".\n\nUse the optional `groupIds` field to add group IDs in an array within the organisation contact. This will become a group contact.",
"tags": [
"Organization Contacts"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.",
"required": true,
"example": "0ae87ade-8c8a-4952-af08-318798958d0c",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"schemas": "urn:cisco:codev:identity:contact:core:1.0",
"displayName": "John Andersen",
"firstName": "John",
"lastName": "Andersen",
"companyName": "Cisco Systems",
"title": "GM",
"address": "{\\\"city\\\" : \\\"Milpitas\\\", \\\"country\\\" : \\\"US\\\", \\\"street\\\" : \\\"1099 Bird Ave.\\\", \\\"zipCode\\\" : \\\"99212\\\"}",
"avatarURL": "https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600",
"primaryContactMethod": "SIPADDRESS",
"source": "Webex4Broadworks",
"emails": [
{
"value": "user1@example.home.com",
"type": "home",
"primary": false
}
],
"phoneNumbers": [
{
"value": "400 123 1234",
"type": "work",
"primary": true
}
],
"sipAddresses": [
{
"value": "sipAddress value1",
"type": "enterprise",
"primary": true
}
],
"ims": [
{
"value": "aim_account_ID",
"type": "aim",
"primary": true
}
],
"groupIds": [
"9ac175bf-0249-4287-8fb3-e320e525fcf6"
]
},
"schema": {
"$ref": "#/components/schemas/Contact"
}
}
}
}
}
},
"/contacts/organizations/{orgId}/contacts/{contactId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactResponse"
},
"example": {
"schemas": "urn:cisco:codev:identity:contact:core:1.0",
"meta": {
"created": "2023-05-11T02:55:25.460Z",
"lastModified": "2023-05-11T02:55:25.460Z"
},
"contactId": "6847ee0f-5e9c-4403-9f0e-0aa8552f7829",
"firstName": "Simic",
"lastName": "Zhang",
"companyName": "Cisco Systems",
"title": "Product Manager",
"address": "{\"city\" : \"Milpitas\", \"country\" : \"US\", \"street\" : \"1099 Bird Ave.\", \"zipCode\" : \"99212\"}",
"avatarURL": "https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600",
"displayName": "Logan",
"addressInfo": {
"city": "Milpitas",
"country": "US",
"street": "1099 Bird Ave.",
"zipCode": "99212"
},
"primaryContactMethod": "EMAIL",
"phoneNumbers": [
{
"type": "work",
"value": "20134319"
}
],
"emails": [
{
"type": "work",
"value": "simizhan@example.com"
}
],
"sipAddresses": [
{
"type": "work",
"value": "sip://mysip1231233"
}
],
"ims": [
{
"type": "work",
"value": "87003922"
}
],
"source": "CH",
"isMigration": false,
"orgId": "d23736ac-8055-433e-b85a-0fc55c96ead9",
"groupIds": [
"b3e594aa-19ea-488a-9d42-f811e272f4bd"
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get a Contact",
"operationId": "Get a Contact",
"description": "Shows details for an organization contact by ID.\nSpecify the organization ID in the `orgId` parameter in the URI, and specify the contact ID in the `contactId` parameter in the URI.\n\n**NOTE**:\nThe `orgId` used in the path for this API are the org UUIDs. They follow a xxxx-xxxx-xxxx-xxxx pattern. If you have an orgId in base64 encoded format (starting with Y2.....) you need to base64 decode the id and extract the UUID from the slug, before you use it in your API call.",
"tags": [
"Organization Contacts"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.",
"required": true,
"example": "d23736ac-8055-433e-b85a-0fc55c96ead8",
"schema": {
"type": "string"
}
},
{
"name": "contactId",
"in": "path",
"description": "The contact ID.",
"required": true,
"example": "6847ee0f-5e9c-4403-9f0e-0aa8552f7828",
"schema": {
"type": "string"
}
}
]
},
"patch": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"schemas": {
"type": "string"
},
"meta": {
"type": "object",
"properties": {
"created": {
"type": "string"
},
"lastModified": {
"type": "string"
}
}
},
"contactId": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"companyName": {
"type": "string"
},
"title": {
"type": "string"
},
"address": {
"type": "string"
},
"avatarURL": {
"type": "string"
},
"displayName": {
"type": "string"
},
"addressInfo": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"street": {
"type": "string"
},
"zipCode": {
"type": "string"
}
}
},
"primaryContactMethod": {
"type": "string"
},
"phoneNumbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"sipAddresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"ims": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"source": {
"type": "string"
},
"isMigration": {
"type": "boolean"
},
"orgId": {
"type": "string"
},
"groupIds": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"example": {
"schemas": "urn:cisco:codev:identity:contact:core:1.0",
"meta": {
"created": "2023-05-11T02:55:25.460Z",
"lastModified": "2023-05-11T02:55:25.460Z"
},
"contactId": "6847ee0f-5e9c-4403-9f0e-0aa8552f7829",
"firstName": "Simic",
"lastName": "Zhang",
"companyName": "Cisco Systems",
"title": "Product Manager",
"address": "{\"city\" : \"Milpitas\", \"country\" : \"US\", \"street\" : \"1099 Bird Ave.\", \"zipCode\" : \"99212\"}",
"avatarURL": "https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600",
"displayName": "Logan",
"addressInfo": {
"city": "Milpitas",
"country": "US",
"street": "1099 Bird Ave.",
"zipCode": "99212"
},
"primaryContactMethod": "EMAIL",
"phoneNumbers": [
{
"type": "work",
"value": "20134319"
}
],
"emails": [
{
"type": "work",
"value": "simizhan@example.com"
}
],
"sipAddresses": [
{
"type": "work",
"value": "sip://mysip1231233"
}
],
"ims": [
{
"type": "work",
"value": "87003922"
}
],
"source": "CH",
"isMigration": false,
"orgId": "d23736ac-8055-433e-b85a-0fc55c96ead9",
"groupIds": [
"b3e594aa-19ea-488a-9d42-f811e272f4bd"
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Update a Contact",
"operationId": "Update a Contact",
"description": "Update details for contact by ID. Only an admin can update a contact.\nSpecify the organization ID in the `orgId` parameter in the URI, and specify the contact ID in the `contactId` parameter in the URI.\n\nUse the optional `groupIds` field to update the group IDs by changing the existing array. You can add or remove one or all groups. To remove all associated groups, pass an empty array in the `groupIds` field.",
"tags": [
"Organization Contacts"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.",
"required": true,
"example": "d23736ac-8055-433e-b85a-0fc55c96ead8",
"schema": {
"type": "string"
}
},
{
"name": "contactId",
"in": "path",
"description": "The contact ID.",
"required": true,
"example": "6847ee0f-5e9c-4403-9f0e-0aa8552f7828",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"schemas": "urn:cisco:codev:identity:contact:core:1.0",
"displayName": "John Andersen",
"firstName": "John",
"lastName": "Andersen",
"companyName": "Cisco Systems",
"title": "GM",
"address": "{\\\"city\\\" : \\\"Milpitas\\\", \\\"country\\\" : \\\"US\\\", \\\"street\\\" : \\\"1099 Bird Ave.\\\", \\\"zipCode\\\" : \\\"99212\\\"}",
"avatarURL": "https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600",
"primaryContactMethod": "SIPADDRESS",
"source": "Webex4Broadworks",
"emails": [
{
"value": "user1@example.home.com",
"type": "home",
"primary": false
}
],
"phoneNumbers": [
{
"value": "400 123 1234",
"type": "work",
"primary": true,
"operation": "delete"
}
],
"sipAddresses": [
{
"value": "sipAddress value1",
"type": "enterprise",
"primary": true
}
],
"ims": [
{
"value": "aim_account_ID",
"type": "aim",
"primary": true
}
],
"groupIds": [
"9ac175bf-0249-4287-8fb3-e320e525fcf6"
]
},
"schema": {
"$ref": "#/components/schemas/UpdateContact"
}
}
}
}
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Delete a Contact",
"operationId": "Delete a Contact",
"description": "Remove a contact from the organization. Only an admin can remove a contact.\n\nSpecify the organization ID in the `orgId` parameter in the URI, and specify the contact ID in the `contactId` parameter in the URI.",
"tags": [
"Organization Contacts"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.",
"required": true,
"example": "d23736ac-8055-433e-b85a-0fc55c96ead8",
"schema": {
"type": "string"
}
},
{
"name": "contactId",
"in": "path",
"description": "The contact ID.",
"required": true,
"example": "6847ee0f-5e9c-4403-9f0e-0aa8552f7828",
"schema": {
"type": "string"
}
}
]
}
},
"/contacts/organizations/{orgId}/contacts/search": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResponse"
},
"example": {
"result": [
{
"schemas": "urn:cisco:codev:identity:contact:core:1.0",
"meta": {
"created": "2023-05-11T01:59:38.398Z",
"lastModified": "2023-05-11T01:59:38.398Z"
},
"contactId": "441d0fa5-7fa0-491e-b27a-f017896c0bab",
"firstName": "Simic",
"lastName": "Zhang",
"companyName": "Cisco Systems",
"title": "Product Manager",
"address": "{\"city\" : \"Milpitas\", \"country\" : \"US\", \"street\" : \"1099 Bird Ave.\", \"zipCode\" : \"99212\"}",
"avatarURL": "https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600",
"displayName": "Logan",
"addressInfo": {
"city": "Milpitas",
"country": "US",
"street": "1099 Bird Ave.",
"zipCode": "99212"
},
"primaryContactMethod": "EMAIL",
"phoneNumbers": [
{
"type": "work",
"value": "20134319"
}
],
"emails": [
{
"type": "work",
"value": "simizhan@example.com"
}
],
"sipAddresses": [
{
"type": "work",
"value": "sip://mysip1231233"
}
],
"ims": [
{
"type": "work",
"value": "87003922"
}
],
"source": "CH",
"isMigration": false,
"orgId": "d23736ac-8055-433e-b85a-0fc55c96ead9",
"groupIds": [
"b3e594aa-19ea-488a-9d42-f811e272f4bd"
]
}
],
"start": 0,
"limit": 1000,
"total": 1
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Contacts",
"operationId": "List Contacts",
"description": "List contacts in the organization. The default limit is `100`.\n\n`keyword` can be the value of \"displayName\", \"firstName\", \"lastName\", \"email\". An empty string of `keyword` means get all contacts.\n\n`groupIds` is a comma separated list group IDs. Results are filtered based on those group IDs.\n\nLong result sets will be split into [pages](/docs/basics#pagination).",
"tags": [
"Organization Contacts"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The organization ID.",
"required": true,
"example": "d23736ac-8055-433e-b85a-0fc55c96ead8",
"schema": {
"type": "string"
}
},
{
"name": "keyword",
"in": "query",
"description": "List contacts with a keyword.",
"example": "john.andersen@example.com",
"schema": {
"type": "string"
}
},
{
"name": "source",
"in": "query",
"description": "List contacts with source.",
"example": "CH",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit the maximum number of contact in the response.\n + Default: 100\n",
"example": "100",
"schema": {
"type": "number"
}
},
{
"name": "groupIds",
"in": "query",
"description": "Filter contacts based on groups.",
"example": "9ac175bf-0249-4287-8fb3-e320e525fcf6,23b95024-7063-404c-9a3c-37532f53a9ce",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "9ac175bf-0249-4287-8fb3-e320e525fcf6,23b95024-7063-404c-9a3c-37532f53a9ce"
},
"description": "Filter contacts based on groups."
}
}
]
}
},
"/contacts/organizations/{orgId}/contacts/bulk": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkCreateResponse"
},
"example": {
"contacts": [
{
"schemas": "urn:cisco:codev:identity:contact:core:1.0",
"meta": {
"created": "2023-05-12T06:53:12.141Z",
"lastModified": "2023-05-12T06:53:12.142Z"
},
"contactId": "5a521987-5407-4824-9389-d4ca82b85752",
"displayName": "simizhan1",
"emails": [
{
"type": "WORK",
"value": "simizhan1@example.com"
}
],
"source": "CH",
"isMigration": false,
"orgId": "d23736ac-8055-433e-b85a-0fc55c96ead9"
},
null,
null
],
"failedContacts": [
{
"id": "1",
"errorCode": "external.non.privilege",
"errorMessage": "Caller is not authorized for source null, only sources [CH] are allowed",
"statusCode": 403
},
{
"id": "2",
"errorCode": "external.non.privilege",
"errorMessage": "Caller is not authorized for source null, only sources [CH] are allowed",
"statusCode": 403
}
],
"orgId": "d23736ac-8055-433e-b85a-0fc55c96ead9"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Bulk Create or Update Contacts",
"operationId": "Bulk Create or Update Contacts",
"description": "Create or update contacts in bulk. Update an existing contact by specifying the contact ID in the `contactId` parameter in the request body.",
"tags": [
"Organization Contacts"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.",
"required": true,
"example": "0ae87ade-8c8a-4952-af08-318798958d0c",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"schemas": "urn:cisco:codev:identity:contact:core:1.0",
"contacts": [
{
"contactId": "6847ee0f-5e9c-4403-9f0e-0aa8552f7828",
"displayName": "John Andersen",
"firstName": "John",
"lastName": "Andersen",
"companyName": "Cisco Systems",
"title": "GM",
"address": "{\\\"city\\\" : \\\"Milpitas\\\", \\\"country\\\" : \\\"US\\\", \\\"street\\\" : \\\"1099 Bird Ave.\\\", \\\"zipCode\\\" : \\\"99212\\\"}",
"avatarURL": "https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600",
"primaryContactMethod": "SIPADDRESS",
"source": "Webex4Broadworks",
"emails": [
{
"value": "user1@example.home.com",
"type": "home",
"primary": false
}
],
"phoneNumbers": [
{
"value": "400 123 1234",
"type": "work",
"primary": true
}
],
"sipAddresses": [
{
"value": "sipAddress value1",
"type": "enterprise",
"primary": true
}
],
"ims": [
{
"value": "aim_account_ID",
"type": "aim",
"primary": true
}
]
}
]
},
"schema": {
"$ref": "#/components/schemas/BulkCreate"
}
}
}
}
}
},
"/contacts/organizations/{orgId}/contacts/bulk/delete": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Bulk Delete Contacts",
"operationId": "Bulk Delete Contacts",
"description": "Delete contacts in bulk.",
"tags": [
"Organization Contacts"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Webex Identity assigned organization identifier for the user's organization or the organization he manages.",
"required": true,
"example": "0ae87ade-8c8a-4952-af08-318798958d0c",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"schemas": "urn:cisco:codev:identity:contact:core:1.0",
"objectIds": [
"8a5fac49-2c5f-4773-aec7-02db0e3a9d72"
]
},
"schema": {
"$ref": "#/components/schemas/BulkDelete"
}
}
}
}
}
},
"/organizations": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationCollectionResponse"
},
"example": {
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"displayName": "Acme, Inc.",
"created": "2015-10-18T14:26:16+00:00"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Organizations",
"operationId": "List Organizations",
"description": "List all organizations visible by your account. The results will not be [paginated](/docs/basics#pagination).",
"tags": [
"Organizations"
],
"parameters": []
}
},
"/organizations/{orgId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organization"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"displayName": "Acme, Inc.",
"created": "2015-10-18T14:26:16+00:00"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Organization Details",
"operationId": "Get Organization Details",
"description": "Shows details for an organization, by ID.\n\nSpecify the org ID in the `orgId` parameter in the URI.",
"tags": [
"Organizations"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The unique identifier for the organization.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"schema": {
"type": "string"
}
}
]
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Delete Organization",
"operationId": "Delete Organization",
"description": "Deletes an organization, by ID. It may take up to 10 minutes for the organization to be deleted after the response is returned.\n
\nSpecify the org ID in the `orgId` parameter in the URI.\n\nDeleting your organization permanently deletes all of the information associated with your organization and is irreversible.
\n\nDeleting an Organization may fail with a HTTP 409 Conflict response and encounter one or more of the errors described below. Resolve these conditions to allow the delete to succeed.\n
\n\n+ Org cannot be deleted as it has Linked sites.\n\n+ Org cannot be deleted as it has active subscriptions or licenses.\n\n+ Org cannot be deleted as [Directory Synchronization](https://developer.webex.com/docs/api/v1/broadworks-enterprises/get-directory-sync-status-for-an-enterprise) is enabled.\n\n+ Org cannot be deleted as it has more than 1 user.\n\n+ Org cannot be deleted as it has more than 1 managed by relationship.\n\n+ Org cannot be deleted as it has managed orgs.\n\n\nWhen deleting a Webex for BroadWorks Organization with BroadWorks Directory Synchronization enabled, a prerequisite is to disable BroadWorks Directory Synchronization for the given Organization. Refer to the [Organization Deletion](https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide#organization-deletion) section of the [Webex for BroadWorks](/docs/api/guides/webex-for-broadworks-developers-guide) guide for more information.\n
",
"tags": [
"Organizations"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The unique identifier for the organization.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"schema": {
"type": "string"
}
}
]
}
},
"/partner/organizations": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManagedOrgsResponse"
},
"example": {
"items": [
{
"orgId": "Y2LZY29ZCGFYAZOVL3VZL1BFT1BMRS9MNWIZNJE4NY1JOGRKLTQ3MJCTOGIYZI1MOWM0NDDMMJKWNDY",
"role": "YXRSYXMTCG9YDGFSLNBHCNRUZXIUC2FSZXNMDWXSYWRTAW4="
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get all customers managed by a partner admin",
"operationId": "Get all customers managed by a partner admin",
"description": "Get all customer organizations managed by given partner admin, in the `managedBy` request parameter. The `managedBy` user typically has the role of a Partner Admin. In case where a Partner Full Admin or Partner Read-Only admin is selected an error like \"The user already has access to all customers managed by their partner organization.\" is shown as a Partner Admin (Full and Read-Only) is able to manage all customers by default. This does not include customers managed through Customer Groups.\n\nThis API can be invoked by Partner Full Admin and Partner Readonly Admin.\nSpecify the `personId` in the `managedBy` parameter in the URI.",
"tags": [
"Partner Administrators"
],
"parameters": [
{
"name": "managedBy",
"in": "query",
"description": "List customer orgs associated with this person ID.",
"required": true,
"example": "Y2LZY29ZCGFYAZOVL3VZL1BFT1BMRS9JOTYWOTZIYI1KYTRHLTQ3NZETYTC2ZI1KNDEZODQWZWVM1TQ",
"schema": {
"type": "string"
}
}
]
}
},
"/partner/organizations/{orgId}/partnerAdmins": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartneradminsfororgResponse"
},
"example": {
"items": [
{
"id": "Y2LZY29ZCGFYAZOVL3VZL1BFT1BMRS9JOTYWOTZIYI1KYTRHLTQ3NZETYTC2ZI1KNDEZODQWZWVM1TQ",
"displayName": "display name",
"firstName": "John",
"lastName": "Doe",
"emails": [
"johndoe@example.com"
],
"roleInCustomerOrg": "id_full_admin"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get all partner admins assigned to a customer",
"operationId": "Get all partner admins assigned to a customer",
"description": "For a given customer, get all the partner admins with their role details. This does not include partner admins who have access through Customer Groups.\nThis API can be used by Partner Full Admins.\n\nSpecify the `orgId` in the path parameter.",
"tags": [
"Partner Administrators"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "List partner admins associated with this customer org ID.",
"required": true,
"example": "Y2LZY29ZCGFYAZOVL3VZL09SR0FOSVPBVELPTI8XZWI2NWZKZI05NJQZLTQXN2YTOTK3NC1HZDCYY2FLM9UXMGY",
"schema": {
"type": "string"
}
}
]
}
},
"/partner/organizations/{orgId}/partnerAdmin/{personId}/assign": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Assign partner admin to a customer",
"operationId": "Assign partner admin to a customer",
"description": "Assign a specific Partner Admin to a customer organization. The partner admin is a user that has the Partner Administrator role.\nOther partner roles, such as Partner Full Administrator are not applicable for this API, since this role manages all customer organizations.\n\nThis API can be used b a Partner Full Admin.\n\nSpecify the `orgId` and the `personId` in the path param.",
"tags": [
"Partner Administrators"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The ID of the customer organization.",
"required": true,
"example": "Y2LZY29ZCGFYAZOVL3VZL09SR0FOSVPBVELPTI85NMFIYZJHYS0ZZGNJLTEXZTUTYTE1MI1MZTM0ODE5Y2RJOWE",
"schema": {
"type": "string"
}
},
{
"name": "personId",
"in": "path",
"description": "User ID of the partner admin in the partners org.",
"required": true,
"example": "Y2LZY29ZCGFYAZOVL3VZL1BFT1BMRS80ZGEZYTI0OC05YJBHLTQXMDGTODU0NC1INTQWMZEYZTU2M2E",
"schema": {
"type": "string"
}
}
]
}
},
"/partner/organizations/{orgId}/partnerAdmin/{personId}/unassign": {
"delete": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Unassign partner admin from a customer",
"operationId": "Unassign partner admin from a customer",
"description": "Unassign a specific partner admin from a customer organization. Unassigning a customer organization from a partner admin does not remove the role from the user. If a partner admin is also managing the customer organization through a Customer Group, they will continue to have access.\nThis API can be used by Partner Full Admin.\n\nSpecify the `orgId` and the `personId` in the path param.",
"tags": [
"Partner Administrators"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The ID of the customer organization.",
"required": true,
"example": "Y2LZY29ZCGFYAZOVL3VZL09SR0FOSVPBVELPTI85NMFIYZJHYS0ZZGNJLTEXZTUTYTE1MI1MZTM0ODE5Y2RJOWE",
"schema": {
"type": "string"
}
},
{
"name": "personId",
"in": "path",
"description": "User ID of the partner admin in the partners org.",
"required": true,
"example": "Y2LZY29ZCGFYAZOVL3VZL1BFT1BMRS80ZGEZYTI0OC05YJBHLTQXMDGTODU0NC1INTQWMZEYZTU2M2E",
"schema": {
"type": "string"
}
}
]
}
},
"/partner/organizations/partnerAdmin/{personId}": {
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Revoke all partner admin roles for a given person ID",
"operationId": "Revoke all partner admin roles for a given person ID",
"description": "Revoke all partner administrator roles from a user, thereby revoking access to Partner Hub and all managed customer organizations.\nThis action does not grant or revoke Control Hub administrator roles (e.g. Full Administrator, User and Device Administrator, etc.).\nThis API can be used by Partner Full Admin.\nSpecify the `personId` in the path param.",
"tags": [
"Partner Administrators"
],
"parameters": [
{
"name": "personId",
"in": "path",
"description": "ID of the user whose partner roles needs to be revoked.",
"required": true,
"example": "Y2LZY29ZCGFYAZOVL3VZL1BFT1BMRS9JOTYWOTZIYI1KYTRHLTQ3NZETYTC2ZI1KNDEZODQWZWVM1TQ",
"schema": {
"type": "string"
}
}
]
}
},
"/partner/reports": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportCollectionResponse"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Reports",
"operationId": "listReports",
"description": "Lists all reports previously generated from a given region. Use query parameters to filter the response. The parameters are optional.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_read` and `identity:people_read` scopes.\n\nCSV reports for Webex suite services are only supported for organizations based in one region per API request. Organizations based in a different region will require a separate request with region specified.
\n\nWhen no region is specified, the request defaults to Partner organization's home region.
\n\nReports are usually provided in zip format. A content-header application/zip or application/octet-stream does indicate the zip format. There is usually no .zip file extension.
",
"tags": [
"Partner Reports/Templates"
],
"parameters": [
{
"name": "service",
"in": "query",
"description": "List reports which use this service.",
"example": "Webex",
"schema": {
"type": "string"
}
},
{
"name": "templateId",
"in": "query",
"description": "List reports with this report template ID.",
"example": 5,
"schema": {
"type": "number"
}
},
{
"name": "from",
"in": "query",
"description": "List reports that were created on or after this date.",
"example": "2024-05-01",
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"description": "List reports that were created before this date.",
"example": "2024-05-05",
"schema": {
"type": "string"
}
},
{
"name": "regionId",
"in": "query",
"description": "Data in the report will be from organizations in this region, for example, US, CA, or EU.",
"example": "US",
"schema": {
"type": "string"
}
},
{
"name": "onBehalfOfSubPartnerOrgId",
"in": "query",
"description": "The encoded organization ID for the sub partner.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"schema": {
"type": "string"
}
}
]
},
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reportId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
"description": "The unique identifier for the report."
},
"createdTime": {
"type": "string",
"example": "2024-05-27 17:02:43",
"description": "The time of report creation."
}
}
},
"example": {
"reportId": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9SRVBPUlQvYWQwZDIwNTc1ZGEwNDVhNDhmYWQ0N2Q5NzRhYjQxZjI",
"createdTime": "2024-05-27 17:02:43"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Create a Report",
"operationId": "createAReport",
"description": "Create a new report. A new report can be created using `templateId` available from the _List Report Templates_ API. For each `templateId`, there are a set of validation rules that need to be followed.\n\nThe `templateId` parameter is a number. However, it is a limitation of developer.webex.com platform that it is passed as a string when you try to test the API from here.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_write` and `identity:people_read` scopes.\n\n**Notes**:\n\nCSV reports for Webex suite services are only created for organizations in the specified region. Organizations based in a different region will require a separate request with region specified.
\n\nWhen no region is specified, the request defaults to Partner organization's home region. A request against a region where there are no organizations will return blank CSV files.
",
"tags": [
"Partner Reports/Templates"
],
"parameters": [
{
"name": "onBehalfOfSubPartnerOrgId",
"in": "query",
"description": "The encoded organization ID for the sub partner.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"templateId": 5,
"startDate": "2024-05-01",
"endDate": "2024-05-05",
"regionId": "US"
},
"schema": {
"type": "object",
"required": [
"templateId",
"startDate",
"endDate"
],
"properties": {
"templateId": {
"type": "number",
"example": 5,
"description": "Unique ID representing valid report templates."
},
"startDate": {
"type": "string",
"example": "2024-05-01",
"description": "Data in the report will be from this date onwards."
},
"endDate": {
"type": "string",
"example": "2024-05-05",
"description": "Data in the report will be until this date."
},
"regionId": {
"type": "string",
"example": "US",
"description": "Data in the report will be from organizations in this region, for example, US, CA, or EU."
}
}
}
}
}
}
}
},
"/partner/reports/{reportId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Report"
},
"example": {
"reportId": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9SRVBPUlQvYWQwZDIwNTc1ZGEwNDVhNDhmYWQ0N2Q5NzRhYjQxZjI",
"templateId": 5,
"title": "Calling Usage Reports",
"service": "Teams",
"startDate": "2024-02-23",
"endDate": "2024-03-24",
"regionId": "US",
"createdTime": "2024-03-24 17:13:39",
"status": "done",
"fileName": "Calling Usage_12345_Org_2024-05-01_2024-05-05.csv",
"fileSize": 0,
"checksum": "12345",
"downloadURL": "https://downloadservicebts.webex.com/api?reportId=Y2lzY29zcGFyazovL3VzL1JFUE9SVC9hZDBkMjA1NzVkYTA0NWE0OGZhZDQ3ZDk3NGFiNDFmMg",
"downloadUrlExpiryTime": "3600"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Report Details",
"operationId": "getReportDetails",
"description": "Shows details for a report by report ID.\n\nSpecify the report ID in the `reportId` parameter in the URI.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_read` and `identity:people_read` scopes.\n\n**Notes**:\n\nReports are usually provided in zip format. A content-header application/zip or application/octet-stream does indicate the zip format. There is usually no .zip file extension.
",
"tags": [
"Partner Reports/Templates"
],
"parameters": [
{
"name": "reportId",
"in": "path",
"description": "The unique identifier for the report.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9SRVBPUlQvYWQwZDIwNTc1ZGEwNDVhNDhmYWQ0N2Q5NzRhYjQxZjI",
"schema": {
"type": "string"
}
},
{
"name": "onBehalfOfSubPartnerOrgId",
"in": "query",
"description": "The encoded organization ID for the sub partner.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"schema": {
"type": "string"
}
}
]
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Delete a Report",
"operationId": "deleteAReport",
"description": "Remove a report from the system.\n\nSpecify the report ID in the `reportId` parameter in the URI\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_write` scope.",
"tags": [
"Partner Reports/Templates"
],
"parameters": [
{
"name": "reportId",
"in": "path",
"description": "The unique identifier for the report.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9SRVBPUlQvYWQwZDIwNTc1ZGEwNDVhNDhmYWQ0N2Q5NzRhYjQxZjI",
"schema": {
"type": "string"
}
},
{
"name": "onBehalfOfSubPartnerOrgId",
"in": "query",
"description": "The encoded organization ID for the sub partner.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"schema": {
"type": "string"
}
}
]
}
},
"/partner/reports/templates": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateCollectionResponse"
},
"example": [
{
"templateId": 130,
"title": "Calling Usage",
"service": "Teams",
"category": "Partner",
"maxDays": 31,
"dataStartDate": "2024-01-01",
"dataEndDate": "2024-01-31"
}
]
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Report Templates",
"operationId": "listReportTemplates",
"description": "List report templates. Report templates are available for use with the Partner Reports API.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_read` and `identity:people_read` [scopes](/docs/integrations#scopes). The authenticated user must be a Partner full administrator or Partner read-only administrator of the organization.",
"tags": [
"Partner Reports/Templates"
],
"parameters": [
{
"name": "onBehalfOfSubPartnerOrgId",
"in": "query",
"description": "The encoded organization ID for the sub partner.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"schema": {
"type": "string"
}
}
]
}
},
"/people": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Link": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonCollectionResponse"
},
"example": {
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"emails": [
"john.andersen@example.com"
],
"phoneNumbers": [
{
"type": "work",
"value": "+1 408 526 7209",
"primary": true
}
],
"extension": "133",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"displayName": "John Andersen",
"nickName": "John",
"firstName": "John",
"lastName": "Andersen",
"avatar": "https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"roles": [
"Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
],
"licenses": [
"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
],
"department": "Sales",
"manager": "John Duarte",
"managerId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80ZGEzYTI0OC05YjBhLTQxMDgtODU0NC1iNTQwMzEyZTU2M2E",
"title": "GM",
"addresses": [
{
"type": "work",
"country": "US",
"locality": "Milpitas",
"region": "California",
"streetAddress": "1099 Bird Ave.",
"postalCode": "99212"
}
],
"created": "2015-10-18T14:26:16.000Z",
"lastModified": "2015-10-18T14:26:16.000Z",
"timezone": "America/Denver",
"lastActivity": "2015-10-18T14:26:16.028Z",
"siteUrls": [
"mysite.webex.com#attendee"
],
"sipAddresses": [
{
"type": "personal-room",
"value": "testuser5@mycompany.webex.com",
"primary": false
}
],
"xmppFederationJid": "user@example.com",
"status": "active",
"invitePending": "false",
"loginEnabled": "true",
"type": "person"
}
],
"notFoundIds": []
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List People",
"operationId": "List People",
"description": "List people in your organization. For most users, either the `email` or `displayName` parameter is required. Admin users can omit these fields and list all users in their organization.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be returned for people within your organization or an organization you manage. Presence information will not be returned if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/). Calling /people frequently to poll `status` information for a large set of users will quickly lead to `429` errors and throttling of such requests and is therefore discouraged.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`. Admin users can list all users in a location. Admin users will receive an enriched payload with additional administrative fields like `licenses`,`roles`, `locations` etc. These fields are shown when accessing a user via GET /people/{id}, not when doing a GET /people?id=\n\nLookup by `email` is only supported for people within the same org or where a partner admin relationship is in place.\n\nLookup by `roles` is only supported for Admin users for the people within the same org.\n\nLong result sets will be split into [pages](/docs/basics#pagination).",
"tags": [
"People"
],
"parameters": [
{
"name": "email",
"in": "query",
"description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org.",
"example": "john.andersen@example.com",
"schema": {
"type": "string"
}
},
{
"name": "displayName",
"in": "query",
"description": "List people whose name starts with this string. For non-admin requests, either this or email are required.",
"example": "John Andersen",
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "query",
"description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response.",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"schema": {
"type": "string"
}
},
{
"name": "orgId",
"in": "query",
"description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"schema": {
"type": "string"
}
},
{
"name": "roles",
"in": "query",
"description": "List of roleIds separated by commas.",
"example": "Y2lzY29zcGFyazovL3VzL1JPTEUvYXRsYXMtcG9ydGFsLnBhcnRuZXIuc2FsZXNhZG1pbg",
"schema": {
"type": "string"
}
},
{
"name": "callingData",
"in": "query",
"description": "Include Webex Calling user details in the response.",
"example": true,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "locationId",
"in": "query",
"description": "List people present in this location.",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"schema": {
"type": "string"
}
},
{
"name": "max",
"in": "query",
"description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50.",
"example": 100,
"schema": {
"type": "number",
"default": 100
}
},
{
"name": "excludeStatus",
"in": "query",
"description": "Omit people status/availability to enhance query performance.",
"example": true,
"schema": {
"type": "boolean",
"default": false
}
}
]
},
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"emails": [
"john.andersen@example.com"
],
"phoneNumbers": [
{
"type": "work",
"value": "+1 408 526 7209",
"primary": true
}
],
"extension": "133",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"displayName": "John Andersen",
"nickName": "John",
"firstName": "John",
"lastName": "Andersen",
"avatar": "https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"roles": [
"Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
],
"licenses": [
"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
],
"department": "Sales",
"manager": "John Duarte",
"managerId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80ZGEzYTI0OC05YjBhLTQxMDgtODU0NC1iNTQwMzEyZTU2M2E",
"title": "GM",
"addresses": [
{
"type": "work",
"country": "US",
"locality": "Milpitas",
"region": "California",
"streetAddress": "1099 Bird Ave.",
"postalCode": "99212"
}
],
"created": "2015-10-18T14:26:16.000Z",
"lastModified": "2015-10-18T14:26:16.000Z",
"timezone": "America/Denver",
"lastActivity": "2015-10-18T14:26:16.028Z",
"siteUrls": [
"mysite.webex.com#attendee"
],
"sipAddresses": [
{
"type": "personal-room",
"value": "testuser5@mycompany.webex.com",
"primary": false
}
],
"xmppFederationJid": "user@example.com",
"status": "active",
"invitePending": "false",
"loginEnabled": "true",
"type": "person"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Create a Person",
"operationId": "Create a Person",
"description": "Create a new user account for a given organization. Only an admin can create a new user account.\n\nAt least one of the following body parameters is required to create a new user: `displayName`, `firstName`, `lastName`.\n\nCurrently, users may have only one email address associated with their account. The `emails` parameter is an array, which accepts multiple values to allow for future expansion, but currently only one email address will be used for the new user.\n\nAdmin users can include `Webex calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true. It may happen that the POST request with calling data returns a 400 status, but the person was created still. One way to get into this state is if an invalid phone number is assigned to a user. The people API aggregates calls to several other microservices, and one may have failed. A best practice is to check if the user exists before retrying. This can be done with the user's email address and a GET /people.\n\nWhen doing attendee management, append `#attendee` to the `siteUrl` parameter (e.g. `mysite.webex.com#attendee`) to make the new user an attendee for a site.\n\n**NOTES**:\n\n* For creating a `Webex Calling` user, you must provide `phoneNumbers` or `extension`, `locationId`, and `licenses` string in the same request.\n\n* `SipAddresses` are asigned via an asynchronous process. This means that the POST response may not show the SIPAddresses immediately. Instead you can verify them with a separate GET to /people, after they were newly configured.\n\n* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it is possible that not all requested licenses are assigned to the user.",
"tags": [
"People"
],
"parameters": [
{
"name": "callingData",
"in": "query",
"description": "Include Webex Calling user details in the response.",
"example": true,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "minResponse",
"in": "query",
"description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details.",
"example": true,
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"emails": [
"john.andersen@example.com"
],
"phoneNumbers": [
{
"type": "work",
"value": "408 526 7209"
}
],
"extension": "133",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"displayName": "John Andersen",
"firstName": "John",
"lastName": "Andersen",
"avatar": "https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"roles": [
"Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
],
"licenses": [
"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
],
"department": "Sales",
"manager": "John Duarte",
"managerId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80ZGEzYTI0OC05YjBhLTQxMDgtODU0NC1iNTQwMzEyZTU2M2E",
"title": "GM",
"addresses": [
{
"type": "work",
"country": "US",
"locality": "Milpitas",
"region": "California",
"streetAddress": "1099 Bird Ave.",
"postalCode": "99212"
}
],
"siteUrls": [
"mysite.webex.com#attendee"
]
},
"schema": {
"type": "object",
"required": [
"emails"
],
"properties": {
"emails": {
"type": "array",
"items": {
"type": "string",
"example": "john.andersen@example.com"
},
"description": "The email addresses of the person. Only one email address is allowed per person."
},
"phoneNumbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"work"
],
"description": "The type of phone number."
},
"value": {
"type": "string",
"example": "408 526 7209",
"description": "The phone number."
}
}
},
"description": "Phone numbers for the person. Only settable for Webex Calling. Requires a Webex Calling license."
},
"extension": {
"type": "string",
"example": "133",
"description": "Webex Calling extension of the person. This is only settable for a person with a Webex Calling license."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"description": "The ID of the location for this person."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "The full name of the person."
},
"firstName": {
"type": "string",
"example": "John",
"description": "The first name of the person."
},
"lastName": {
"type": "string",
"example": "Andersen",
"description": "The last name of the person."
},
"avatar": {
"type": "string",
"example": "https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600",
"description": "The URL to the person's avatar in PNG format."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The ID of the organization to which this person belongs."
},
"roles": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
},
"description": "An array of role strings representing the roles to which this admin user belongs."
},
"licenses": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
},
"description": "An array of license strings allocated to this person."
},
"department": {
"type": "string",
"example": "Sales",
"description": "The business department the user belongs to."
},
"manager": {
"type": "string",
"example": "John Duarte",
"description": "A manager identifier."
},
"managerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80ZGEzYTI0OC05YjBhLTQxMDgtODU0NC1iNTQwMzEyZTU2M2E",
"description": "Person ID of the manager."
},
"title": {
"type": "string",
"example": "GM",
"description": "The person's title."
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "work",
"description": "The type of address."
},
"country": {
"type": "string",
"example": "US",
"description": "The user's country."
},
"locality": {
"type": "string",
"example": "Milpitas",
"description": "The user's locality, often city."
},
"region": {
"type": "string",
"example": "California",
"description": "The user's region, often state."
},
"streetAddress": {
"type": "string",
"example": "1099 Bird Ave.",
"description": "The user's street."
},
"postalCode": {
"type": "string",
"example": "99212",
"description": "The user's postal or zip code."
}
}
},
"description": "A person's addresses."
},
"siteUrls": {
"type": "array",
"items": {
"type": "string",
"example": "mysite.webex.com#attendee"
},
"description": "One or several site names where this user has an attendee role. Append `#attendee` to the sitename (e.g.: `mysite.webex.com#attendee`)."
}
}
}
}
}
}
}
},
"/people/{personId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"emails": [
"john.andersen@example.com"
],
"phoneNumbers": [
{
"type": "work",
"value": "+1 408 526 7209",
"primary": true
}
],
"extension": "133",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"displayName": "John Andersen",
"nickName": "John",
"firstName": "John",
"lastName": "Andersen",
"avatar": "https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"roles": [
"Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
],
"licenses": [
"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
],
"department": "Sales",
"manager": "John Duarte",
"managerId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80ZGEzYTI0OC05YjBhLTQxMDgtODU0NC1iNTQwMzEyZTU2M2E",
"title": "GM",
"addresses": [
{
"type": "work",
"country": "US",
"locality": "Milpitas",
"region": "California",
"streetAddress": "1099 Bird Ave.",
"postalCode": "99212"
}
],
"created": "2015-10-18T14:26:16.000Z",
"lastModified": "2015-10-18T14:26:16.000Z",
"timezone": "America/Denver",
"lastActivity": "2015-10-18T14:26:16.028Z",
"siteUrls": [
"mysite.webex.com#attendee"
],
"sipAddresses": [
{
"type": "personal-room",
"value": "testuser5@mycompany.webex.com",
"primary": false
}
],
"xmppFederationJid": "user@example.com",
"status": "active",
"invitePending": "false",
"loginEnabled": "true",
"type": "person"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Person Details",
"operationId": "Get Person Details",
"description": "Shows details for a person, by ID.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be displayed for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/).\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`.\n\nSpecify the person ID in the `personId` parameter in the URI.",
"tags": [
"People"
],
"parameters": [
{
"name": "personId",
"in": "path",
"description": "A unique identifier for the person.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"schema": {
"type": "string"
}
},
{
"name": "callingData",
"in": "query",
"description": "Include Webex Calling user details in the response.",
"example": true,
"schema": {
"type": "boolean",
"default": false
}
}
]
},
"put": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"emails": [
"john.andersen@example.com"
],
"phoneNumbers": [
{
"type": "work",
"value": "+1 408 526 7209",
"primary": true
}
],
"extension": "133",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"displayName": "John Andersen",
"nickName": "John",
"firstName": "John",
"lastName": "Andersen",
"avatar": "https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"roles": [
"Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
],
"licenses": [
"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
],
"department": "Sales",
"manager": "John Duarte",
"managerId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80ZGEzYTI0OC05YjBhLTQxMDgtODU0NC1iNTQwMzEyZTU2M2E",
"title": "GM",
"addresses": [
{
"type": "work",
"country": "US",
"locality": "Milpitas",
"region": "California",
"streetAddress": "1099 Bird Ave.",
"postalCode": "99212"
}
],
"created": "2015-10-18T14:26:16.000Z",
"lastModified": "2015-10-18T14:26:16.000Z",
"timezone": "America/Denver",
"lastActivity": "2015-10-18T14:26:16.028Z",
"siteUrls": [
"mysite.webex.com#attendee"
],
"sipAddresses": [
{
"type": "personal-room",
"value": "testuser5@mycompany.webex.com",
"primary": false
}
],
"xmppFederationJid": "user@example.com",
"status": "active",
"invitePending": "false",
"loginEnabled": "true",
"type": "person"
}
}
}
},
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Update a Person",
"operationId": "Update a Person",
"description": "Update details for a person, by ID.\n\nSpecify the person ID in the `personId` parameter in the URI. Only an admin can update a person details.\n\nInclude all details for the person. This action expects all user details to be present in the request. A common approach is to first [GET the person's details](/docs/api/v1/people/get-person-details), make changes, then PUT both the changed and unchanged values.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.\n\nWhen doing attendee management, to update a user from host role to an attendee for a site append `#attendee` to the respective `siteUrl` and remove the meeting host license for this site from the license array.\nTo update a person from an attendee role to a host for a site, add the meeting license for this site in the meeting array, and remove that site from the `siteurl` parameter.\n\nTo remove the attendee privilege for a user on a meeting site, remove the `sitename#attendee` from the `siteUrl`s array. The `showAllTypes` parameter must be set to `true`.\n\n**NOTE**:\n\n* The `locationId` can only be set when assigning a calling license to a user. It cannot be changed if a user is already an existing calling user.\n\n* The `extension` field should be used to update the Webex Calling extension for a person. The extension value should not include the location routing prefix. The `work_extension` type in the `phoneNumbers` object as seen in the response payload of [List People](/docs/api/v1/people/list-people) or [Get Person Details](/docs/api/v1/people/get-person-details), cannot be used to set the Webex Calling extension for a person.\n\n* When updating a user with multiple email addresses using a PUT request, ensure that the primary email address is listed first in the array. Note that the order of email addresses returned by a GET request is not guaranteed..\n\n* The People API is a combination of several microservices, each responsible for specific attributes of a person. As a result, a PUT request that returns an error response code may still have altered some values of the person's data. Therefore, it is recommended to perform a GET request after encountering an error to verify the current state of the resource. \n\n* Some licenses are implicitly assigned by the system and cannot be admin controlled. They are necessary for the baseline function of the Webex system. If you get an error about implicitly assigned licensed that cannot be removed, please ensure you have the corresponding license in your PUT request.\n\n* When assigning multiple licenses in a single request, the system will assign all valid and available licenses. If any requested licenses cannot be assigned, the operation will continue with the remaining licenses. As a result, it is possible that not all requested licenses are assigned to the user.",
"tags": [
"People"
],
"parameters": [
{
"name": "personId",
"in": "path",
"description": "A unique identifier for the person.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"schema": {
"type": "string"
}
},
{
"name": "callingData",
"in": "query",
"description": "Include Webex Calling user details in the response.",
"example": true,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "showAllTypes",
"in": "query",
"description": "Include additional user data like `#attendee` role.",
"example": true,
"schema": {
"type": "boolean"
}
},
{
"name": "minResponse",
"in": "query",
"description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details.",
"example": true,
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"emails": [
"john.andersen@example.com"
],
"phoneNumbers": [
{
"type": "work",
"value": "408 526 7209"
}
],
"extension": "133",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"displayName": "John Andersen",
"firstName": "John",
"lastName": "Andersen",
"nickName": "John",
"avatar": "https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"roles": [
"Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
],
"licenses": [
"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
],
"department": "Sales",
"manager": "John Duarte",
"managerId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80ZGEzYTI0OC05YjBhLTQxMDgtODU0NC1iNTQwMzEyZTU2M2E",
"title": "GM",
"addresses": [
{
"type": "work",
"country": "US",
"locality": "Milpitas",
"region": "California",
"streetAddress": "1099 Bird Ave.",
"postalCode": "99212"
}
],
"siteUrls": [
"mysite.webex.com#attendee"
],
"loginEnabled": true
},
"schema": {
"type": "object",
"required": [
"displayName"
],
"properties": {
"emails": {
"type": "array",
"items": {
"type": "string",
"example": "john.andersen@example.com"
},
"description": "The email addresses of the person. Only one email address is allowed per person."
},
"phoneNumbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"work"
],
"description": "The type of phone number."
},
"value": {
"type": "string",
"example": "408 526 7209",
"description": "The phone number."
}
}
},
"description": "Phone numbers for the person. Can only be set for Webex Calling. Needs a Webex Calling license."
},
"extension": {
"type": "string",
"example": "133",
"description": "Webex Calling extension of the person. This is only settable for a person with a Webex Calling license."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"description": "The ID of the location for this person."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "The full name of the person."
},
"firstName": {
"type": "string",
"example": "John",
"description": "The first name of the person."
},
"lastName": {
"type": "string",
"example": "Andersen",
"description": "The last name of the person."
},
"nickName": {
"type": "string",
"example": "John",
"description": "The nickname of the person if configured. This cannot be overwritten and instead will be set to the firstName automatically in update requests."
},
"avatar": {
"type": "string",
"example": "https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600",
"description": "The URL to the person's avatar in PNG format."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The ID of the organization to which this person belongs."
},
"roles": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
},
"description": "An array of role strings representing the roles to which this admin user belongs."
},
"licenses": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
},
"description": "An array of license strings allocated to this person."
},
"department": {
"type": "string",
"example": "Sales",
"description": "The business department the user belongs to."
},
"manager": {
"type": "string",
"example": "John Duarte",
"description": "A manager identifier."
},
"managerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80ZGEzYTI0OC05YjBhLTQxMDgtODU0NC1iNTQwMzEyZTU2M2E",
"description": "Person ID of the manager."
},
"title": {
"type": "string",
"example": "GM",
"description": "The person's title."
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "work",
"description": "The type of address."
},
"country": {
"type": "string",
"example": "US",
"description": "The user's country."
},
"locality": {
"type": "string",
"example": "Milpitas",
"description": "The user's locality, often city."
},
"region": {
"type": "string",
"example": "California",
"description": "The user's region, often state."
},
"streetAddress": {
"type": "string",
"example": "1099 Bird Ave.",
"description": "The user's street."
},
"postalCode": {
"type": "string",
"example": "99212",
"description": "The user's postal or zip code."
}
}
},
"description": "A person's addresses."
},
"siteUrls": {
"type": "array",
"items": {
"type": "string",
"example": "mysite.webex.com#attendee"
},
"description": "One or several site names where this user has a role (host or attendee). Append `#attendee` to the site name to designate the attendee role on that site."
},
"loginEnabled": {
"type": "boolean",
"example": true,
"description": "Whether or not the user is allowed to use Webex. This property is only accessible if the authenticated user is an admin user for the person's organization."
}
}
}
}
}
}
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Delete a Person",
"operationId": "Delete a Person",
"description": "Remove a person from the system.\n\n**Required Administrator Roles:**\n\nThe following administrators have permission to use this API:\n\n**Customer Organization:**\n- Full administrator\n- User administrator\n\n**Partner/External Access:**\n- External full administrator\n\n**Note:** External read-only administrators, provisioning administrators, and device administrators cannot delete users.\n\nSpecify the person ID in the `personId` parameter in the URI.",
"tags": [
"People"
],
"parameters": [
{
"name": "personId",
"in": "path",
"description": "A unique identifier for the person.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"schema": {
"type": "string"
}
}
]
}
},
"/people/me": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"emails": [
"john.andersen@example.com"
],
"phoneNumbers": [
{
"type": "work",
"value": "+1 408 526 7209",
"primary": true
}
],
"extension": "133",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"displayName": "John Andersen",
"nickName": "John",
"firstName": "John",
"lastName": "Andersen",
"avatar": "https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"roles": [
"Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
],
"licenses": [
"Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
],
"department": "Sales",
"manager": "John Duarte",
"managerId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80ZGEzYTI0OC05YjBhLTQxMDgtODU0NC1iNTQwMzEyZTU2M2E",
"title": "GM",
"addresses": [
{
"type": "work",
"country": "US",
"locality": "Milpitas",
"region": "California",
"streetAddress": "1099 Bird Ave.",
"postalCode": "99212"
}
],
"created": "2015-10-18T14:26:16.000Z",
"lastModified": "2015-10-18T14:26:16.000Z",
"timezone": "America/Denver",
"lastActivity": "2015-10-18T14:26:16.028Z",
"siteUrls": [
"mysite.webex.com#attendee"
],
"sipAddresses": [
{
"type": "personal-room",
"value": "testuser5@mycompany.webex.com",
"primary": false
}
],
"xmppFederationJid": "user@example.com",
"status": "active",
"invitePending": "false",
"loginEnabled": "true",
"type": "person"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get My Own Details",
"operationId": "Get My Own Details",
"description": "Get profile details for the authenticated user. This is the same as GET `/people/{personId}` using the Person ID associated with your Auth token.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true.",
"tags": [
"People"
],
"parameters": [
{
"name": "callingData",
"in": "query",
"description": "Include Webex Calling user details in the response.",
"example": true,
"schema": {
"type": "boolean",
"default": false
}
}
]
}
},
"/recordingReport/accessSummary": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Link": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json;charset=UTF-8": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecordingReportSummaryObject"
},
"description": "An array of recording audit report summaries objects."
}
}
},
"example": {
"items": [
{
"recordingId": "4f914b1dfe3c4d11a61730f18c0f5387",
"topic": "Example Topic",
"timeRecorded": "2020-07-13T17:05:35Z",
"siteUrl": "site4-example.webex.com",
"hostEmail": "john.andersen@example.com",
"viewCount": 18,
"downloadCount": 10
},
{
"recordingId": "3324fb76946249cfa07fc30b3ccbf580",
"topic": "Example Topic",
"timeRecorded": "2020-07-13T17:05:35Z",
"siteUrl": "site4-example.webex.com",
"hostEmail": "john.andersen@example.com",
"viewCount": 0,
"downloadCount": 2
},
{
"recordingId": "42b80117a2a74dcf9863bf06264f8075",
"topic": "Example Topic",
"timeRecorded": "2020-07-13T17:05:35Z",
"siteUrl": "site4-example.webex.com",
"hostEmail": "john.andersen@example.com",
"viewCount": 7,
"downloadCount": 20
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List of Recording Audit Report Summaries",
"operationId": "List of Recording Audit Report Summaries",
"description": "Lists of recording audit report summaries. You can specify a date range and the maximum number of recording audit report summaries to return.\n\nOnly recording audit report summaries of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the recording audit report summaries of the specified site will be listed; otherwise, recording audit report summaries of the user's preferred site will be listed. All available Webex sites and the preferred site of the user can be retrieved by the `Get Site List` API.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.",
"tags": [
"Recording Report"
],
"parameters": [
{
"name": "max",
"in": "query",
"description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.",
"schema": {
"type": "number",
"default": 10
}
},
{
"name": "from",
"in": "query",
"description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.",
"example": "2020-07-12T09:30:00+08:00",
"schema": {
"type": "string",
"default": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time."
}
},
{
"name": "to",
"in": "query",
"description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days.",
"example": "2020-07-31T09:30:00+08:00",
"schema": {
"type": "string",
"default": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time."
}
},
{
"name": "hostEmail",
"in": "query",
"description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user.",
"example": "john.andersen@example.com",
"schema": {
"type": "string"
}
},
{
"name": "siteUrl",
"in": "query",
"description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.",
"example": "example.webex.com",
"schema": {
"type": "string"
}
},
{
"name": "timezone",
"in": "header",
"description": "e.g. UTC",
"required": false,
"schema": {
"type": "string"
},
"example": "UTC"
}
]
}
},
"/recordingReport/accessDetail": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Link": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json;charset=UTF-8": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecordingReportObject"
},
"description": "An array of recording audit report objects."
}
}
},
"example": {
"items": [
{
"recordingId": "4f914b1dfe3c4d11a61730f18c0f5387",
"topic": "Example Topic",
"name": "John Andersen",
"email": "john.andersen@example.com",
"accessTime": "2020-07-13T17:05:35Z",
"viewed": true,
"downloaded": false
},
{
"recordingId": "4f914b1dfe3c4d11a61730f18c0f5387",
"topic": "Example Topic",
"name": "Brenda Song",
"email": "brenda.song@example.com",
"accessTime": "2020-07-18T19:05:35Z",
"viewed": false,
"downloaded": true
},
{
"recordingId": "4f914b1dfe3c4d11a61730f18c0f5387",
"topic": "Example Topic",
"name": "Joe Doe",
"email": "joeDoe@example.com",
"accessTime": "2020-08-18T19:08:33Z",
"viewed": true,
"downloaded": true
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Recording Audit Report Details",
"operationId": "Get Recording Audit Report Details",
"description": "Retrieves details for a recording audit report with a specified recording ID.\n\nOnly recording audit report details of meetings hosted by or shared with the authenticated user may be retrieved.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.",
"tags": [
"Recording Report"
],
"parameters": [
{
"name": "recordingId",
"in": "query",
"description": "A unique identifier for the recording.",
"required": true,
"example": "4f914b1dfe3c4d11a61730f18c0f5387",
"schema": {
"type": "string"
}
},
{
"name": "hostEmail",
"in": "query",
"description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user.",
"example": "john.andersen@example.com",
"schema": {
"type": "string"
}
},
{
"name": "max",
"in": "query",
"description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.",
"schema": {
"type": "number",
"default": 10
}
},
{
"name": "timezone",
"in": "header",
"description": "e.g. UTC",
"required": false,
"schema": {
"type": "string"
},
"example": "UTC"
}
]
}
},
"/recordingReport/meetingArchiveSummaries": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Link": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json;charset=UTF-8": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecordingAchriveSummaryObject"
},
"description": "An array of meeting archive summaries objects."
}
}
},
"example": {
"items": [
{
"archiveId": "7d7ea5f42b921eace05386ca24ad730e_R_1000634462",
"serviceType": "MeetingCenter",
"title": "Test003_xml",
"createTime": "2022-10-31T15:50:11Z"
},
{
"archiveId": "7d7ea5f42b921eace05386ca24ad730e_R_1000634107",
"serviceType": "MeetingCenter",
"title": "Gang test pwd 01_xml",
"createTime": "2022-10-31T09:08:00Z"
},
{
"archiveId": "7d7ea5f42b921eace05386ca24ad730e_R_1000633967",
"serviceType": "MeetingCenter",
"title": "Numeric password Test2_xml",
"createTime": "2022-10-31T07:53:05Z"
},
{
"archiveId": "7d7ea5f42b921eace05386ca24ad730e_R_1000633912",
"serviceType": "MeetingCenter",
"title": "Numeric password Test2_xml",
"createTime": "2022-10-31T07:44:31Z"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Meeting Archive Summaries",
"operationId": "List Meeting Archive Summaries",
"description": "Lists of meeting archive summaries. You can specify a date range and the maximum number of meeting archive summaries to return.\n\nMeeting archive summaries are only available to full administrators, not even the meeting host.\n\nThe list returned is sorted in descending order by the date and time that the archives were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the meeting archive summaries of the specified site will be listed; otherwise, meeting archive summaries of the user's preferred site will be listed. All available Webex sites and the preferred site of the user can be retrieved by the `Get Site List` API.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.",
"tags": [
"Recording Report"
],
"parameters": [
{
"name": "max",
"in": "query",
"description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.",
"schema": {
"type": "number",
"default": 10
}
},
{
"name": "from",
"in": "query",
"description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days.",
"example": "2020-07-12T09:30:00+08:00",
"schema": {
"type": "string",
"default": "If `to` is specified, the default value is 7 days before `to`; if `to` is not specified, the default value is 7 days before the current date and time."
}
},
{
"name": "to",
"in": "query",
"description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days.",
"example": "2020-07-31T09:30:00+08:00",
"schema": {
"type": "string",
"default": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time."
}
},
{
"name": "siteUrl",
"in": "query",
"description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API.",
"example": "example.webex.com",
"schema": {
"type": "string"
}
},
{
"name": "timezone",
"in": "header",
"description": "e.g. UTC",
"required": false,
"schema": {
"type": "string"
},
"example": "UTC"
}
]
}
},
"/recordingReport/meetingArchives/{archiveId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json;charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/RecordingArchiveReportObject"
},
"example": {
"archiveId": "4E3254897D3A2E24E05386CA24AD93A6_R_1000637312",
"serviceType": "MeetingCenter",
"title": "Marcos Alonso's Personal Room",
"start": "2022-11-03T10:37:32+08:00",
"end": "2022-11-03T10:37:32+08:00",
"hostDisplayName": "Marcos Alonso",
"hostEmail": "marcos@example.com",
"participants": [
{
"correlationId": -25516827,
"displayName": "Marcos Alonso",
"joinedTime": "2022-11-03T10:32:09+08:00",
"leftTime": "2022-11-03T10:37:32+08:00"
},
{
"correlationId": 10947662,
"displayName": "Antoine Griezmann",
"joinedTime": "2022-11-03T10:32:09+08:00",
"leftTime": "2022-11-03T10:37:32+08:00",
"email": "linzhou@example.com"
},
{
"correlationId": -25516842,
"displayName": "Marco Reus",
"joinedTime": "2022-11-03T10:32:09+08:00",
"leftTime": "2022-11-03T10:37:32+08:00"
}
],
"chats": [
{
"type": "public",
"senderName": "Marcos Alonso",
"chatTime": "2022-11-03T10:32:48+08:00",
"target": "All Participants",
"text": "Hi everyone!"
}
],
"polls": [
{
"type": "public",
"startTime": "2022-11-03T10:33:40+08:00",
"endTime": "2022-11-03T10:37:32+08:00",
"content": {
"questionCount": 1,
"userCount": 1,
"votedUserCount": 3,
"questions": [
{
"voteUsers": [
{
"correlationId": -25516827,
"displayName": "Marcos Alonso"
},
{
"correlationId": -25516842,
"displayName": "Antoine Griezmann"
},
{
"correlationId": -25516847,
"displayName": "Marco Reus"
}
],
"question": {
"choiceCount": 3,
"type": "single answer",
"text": "Q1"
},
"answerSummary": [
{
"totalRespondents": 1,
"isCorrect": false,
"text": "1",
"voteUsers": [
{
"correlationId": -25516842,
"displayName": "Antoine Griezmann"
}
]
},
{
"totalRespondents": 2,
"isCorrect": false,
"text": "2",
"voteUsers": [
{
"correlationId": -25516827,
"displayName": "Marcos Alonso"
},
{
"correlationId": -25516847,
"displayName": "Marco Reus"
}
]
},
{
"totalRespondents": 0,
"isCorrect": true,
"text": "3"
}
],
"respondents": [
{
"correlationId": -25516827,
"displayName": "Marcos Alonso",
"answers": [
"2"
]
},
{
"correlationId": -25516842,
"displayName": "Antoine Griezmann",
"answers": [
"1"
]
},
{
"correlationId": -25516847,
"displayName": "Marco Reus",
"answers": [
"2"
]
}
]
}
]
}
}
],
"qas": [
{
"priority": "NA",
"type": "private",
"displayName": "Marcos Alonso",
"questionTime": "2022-11-03T10:32:40+08:00",
"target": "All Panelists",
"question": "What we will do next step?",
"answers": [
{
"displayName": "Marcos Alonso",
"correlationId": -25516827,
"answerTime": "2022-11-03T10:32:34+08:00",
"text": "Go home"
},
{
"displayName": "Adam Zhou",
"correlationId": 10947662,
"email": "linzhou@example.com",
"answerTime": "2022-11-03T10:34:58+08:00",
"text": "Hiking"
},
{
"displayName": "Marcos Alonso",
"correlationId": -25516827,
"answerTime": "2022-11-03T10:32:40+08:00",
"text": "Drink Some"
}
]
},
{
"type": "dismissed",
"displayName": "Marcos Alonso",
"questionTime": "2022-11-03T10:35:30+08:00",
"question": "Thank you for your question. The information that you requested cannot be provided by any of the hosts or cohosts."
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Meeting Archive Details",
"operationId": "Get Meeting Archive Details",
"description": "Retrieves details for a meeting archive report with a specified archive ID, which contains recording metadata.\n\nMeeting archive details are only available to full administrators, not even the meeting host.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.",
"tags": [
"Recording Report"
],
"parameters": [
{
"name": "archiveId",
"in": "path",
"description": "A unique identifier for the meeting archive summary.",
"required": true,
"example": "7d7ea5f42b921eace05386ca24ad730e_R_1000634462",
"schema": {
"type": "string"
}
},
{
"name": "timezone",
"in": "header",
"description": "e.g. UTC",
"required": false,
"schema": {
"type": "string"
},
"example": "UTC"
}
]
}
},
"/recordings": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Link": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json;charset=UTF-8": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecordingObject"
},
"description": "An array of recording objects."
}
}
},
"example": {
"items": [
{
"id": "4f914b1dfe3c4d11a61730f18c0f5387",
"meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
"meetingSeriesId": "f91b6edce9864428af084977b7c68291",
"topic": "Example Topic",
"createTime": "2020-07-13T17:11:35Z",
"timeRecorded": "2020-07-13T17:05:35Z",
"siteUrl": "site4-example.webex.com",
"downloadUrl": "https://site4-example.webex.com/site4/lsr.php?RCID=b91990e37417bda24986e46cf43345ab",
"playbackUrl": "https://site4-example.webex.com/site4/ldr.php?RCID=69201a61d1d94a84aca18817261d1a73",
"password": "********",
"format": "ARF",
"serviceType": "MeetingCenter",
"durationSeconds": 18416,
"sizeBytes": 168103,
"shareToMe": false,
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"status": "available"
},
{
"id": "3324fb76946249cfa07fc30b3ccbf580",
"meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
"meetingSeriesId": "f91b6edce9864428af084977b7c68291",
"topic": "Example Topic",
"createTime": "2020-07-13T17:11:34Z",
"timeRecorded": "2020-07-13T17:05:35Z",
"siteUrl": "site4-example.webex.com",
"downloadUrl": "https://site4-example.webex.com/site4/lsr.php?RCID=8a763939dec1fa26c565700d628fcb98",
"playbackUrl": "https://site4-example.webex.com/site4/ldr.php?RCID=b05e9c4f773745e7b88725cc97bc3161",
"password": "********",
"format": "ARF",
"serviceType": "MeetingCenter",
"durationSeconds": 181562,
"sizeBytes": 199134,
"shareToMe": false,
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"status": "available"
},
{
"id": "42b80117a2a74dcf9863bf06264f8075",
"meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
"meetingSeriesId": "f91b6edce9864428af084977b7c68291",
"topic": "Example Topic",
"createTime": "2020-07-13T17:11:33Z",
"timeRecorded": "2020-07-13T17:05:35Z",
"siteUrl": "site4-example.webex.com",
"downloadUrl": "https://site4-example.webex.com/site4/lsr.php?RCID=0edd48adbb183e7da97884a0a984e877",
"playbackUrl": "https://site4-example.webex.com/site4/ldr.php?RCID=b64b28ebf70e4645954420c295a9fcad",
"password": "********",
"format": "ARF",
"serviceType": "MeetingCenter",
"durationSeconds": 181562,
"sizeBytes": 199134,
"shareToMe": true,
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"status": "available"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Recordings",
"operationId": "listRecordings",
"description": "Lists recordings. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nOnly recordings of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. **NOTE**: when `meetingId` is specified, parameter of `siteUrl` will be ignored.\n\n* If `siteUrl` is specified, recordings of the specified site will be listed; otherwise, the API lists recordings of all the user's sites. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*",
"tags": [
"Recordings"
],
"parameters": [
{
"name": "max",
"in": "query",
"description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.",
"schema": {
"type": "number",
"default": 10
}
},
{
"name": "from",
"in": "query",
"description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.",
"example": "2020-07-12T09:30:00+08:00",
"schema": {
"type": "string",
"default": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before the current date and time."
}
},
{
"name": "to",
"in": "query",
"description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.",
"example": "2020-07-31T09:30:00+08:00",
"schema": {
"type": "string",
"default": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time."
}
},
{
"name": "meetingId",
"in": "query",
"description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If no ID is specified, the operation returns an array of recordings for all meetings of the current user. When `meetingId` is specified, the `siteUrl` parameter is ignored.",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"schema": {
"type": "string"
}
},
{
"name": "hostEmail",
"in": "query",
"description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will return recordings of that user.",
"example": "john.andersen@example.com",
"schema": {
"type": "string"
}
},
{
"name": "siteUrl",
"in": "query",
"description": "URL of the Webex site from which the API lists recordings. If not specified, the API lists recordings from all of a user's sites. All available Webex sites and the preferred site of the user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.",
"example": "example.webex.com",
"schema": {
"type": "string"
}
},
{
"name": "integrationTag",
"in": "query",
"description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain, such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".",
"example": "dbaeceebea5c4a63ac9d5ef1edfe36b9",
"schema": {
"type": "string"
}
},
{
"name": "topic",
"in": "query",
"description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner.",
"example": "John's Meeting",
"schema": {
"type": "string"
}
},
{
"name": "format",
"in": "query",
"description": "Recording's file format. If specified, the API filters recordings by format.",
"example": "ARF",
"schema": {
"type": "string",
"enum": [
"MP4",
"ARF"
]
}
},
{
"name": "serviceType",
"in": "query",
"description": "The service type for recordings. If this item is specified, the API filters recordings by service-type.",
"example": "MeetingCenter",
"schema": {
"type": "string",
"enum": [
"MeetingCenter",
"EventCenter",
"SupportCenter",
"TrainingCenter"
]
}
},
{
"name": "status",
"in": "query",
"description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin. The `purged` status only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.",
"example": "available",
"schema": {
"type": "string",
"default": "available",
"enum": [
"available",
"deleted",
"purged"
]
}
},
{
"name": "timezone",
"in": "header",
"description": "e.g. UTC",
"required": false,
"schema": {
"type": "string"
},
"example": "UTC"
}
]
}
},
"/admin/recordings": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Link": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json;charset=UTF-8": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecordingObjectForAdminAndCO"
},
"description": "An array of recording objects."
}
}
},
"example": {
"items": [
{
"id": "4f914b1dfe3c4d11a61730f18c0f5387",
"meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
"meetingSeriesId": "f91b6edce9864428af084977b7c68291",
"topic": "Example Topic",
"createTime": "2020-07-13T17:11:35Z",
"timeRecorded": "2020-07-13T17:05:35Z",
"hostDisplayName": "John Andersen",
"hostEmail": "john.andersen@example.com",
"siteUrl": "site4-example.webex.com",
"downloadUrl": "https://site4-example.webex.com/site4/lsr.php?RCID=b91990e37417bda24986e46cf43345ab",
"playbackUrl": "https://site4-example.webex.com/site4/ldr.php?RCID=69201a61d1d94a84aca18817261d1a73",
"password": "********",
"format": "ARF",
"serviceType": "MeetingCenter",
"durationSeconds": 18416,
"sizeBytes": 168103,
"shareToMe": false,
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"status": "available"
},
{
"id": "3324fb76946249cfa07fc30b3ccbf580",
"meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
"meetingSeriesId": "f91b6edce9864428af084977b7c68291",
"topic": "Example Topic",
"createTime": "2020-07-13T17:11:34Z",
"timeRecorded": "2020-07-13T17:05:35Z",
"hostDisplayName": "John Andersen",
"hostEmail": "john.andersen@example.com",
"siteUrl": "site4-example.webex.com",
"downloadUrl": "https://site4-example.webex.com/site4/lsr.php?RCID=8a763939dec1fa26c565700d628fcb98",
"playbackUrl": "https://site4-example.webex.com/site4/ldr.php?RCID=b05e9c4f773745e7b88725cc97bc3161",
"password": "********",
"format": "ARF",
"serviceType": "MeetingCenter",
"durationSeconds": 181562,
"sizeBytes": 199134,
"shareToMe": false,
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"status": "available"
},
{
"id": "42b80117a2a74dcf9863bf06264f8075",
"meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
"meetingSeriesId": "f91b6edce9864428af084977b7c68291",
"topic": "Example Topic",
"createTime": "2020-07-13T17:11:33Z",
"timeRecorded": "2020-07-13T17:05:35Z",
"hostDisplayName": "John Andersen",
"hostEmail": "john.andersen@example.com",
"siteUrl": "site4-example.webex.com",
"downloadUrl": "https://site4-example.webex.com/site4/lsr.php?RCID=0edd48adbb183e7da97884a0a984e877",
"playbackUrl": "https://site4-example.webex.com/site4/ldr.php?RCID=b64b28ebf70e4645954420c295a9fcad",
"password": "********",
"format": "ARF",
"serviceType": "MeetingCenter",
"durationSeconds": 181562,
"sizeBytes": 199134,
"shareToMe": false,
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"status": "available"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Recordings For an Admin or Compliance Officer",
"operationId": "listRecordingsForAdminOrComplianceOfficer",
"description": "List recordings for an admin or compliance officer. You can specify a date range, a parent meeting ID, and the maximum number of recordings to return.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `meetingId` is specified, only recordings associated with the specified meeting will be listed. Please note that when `meetingId` is specified, parameters of `siteUrl`, `from`, and `to` will be ignored.\n\n* If `siteUrl` is specified, all the recordings on the specified site are listed; otherwise, all the recordings on the admin user's or compliance officer's preferred site are listed. All the available Webex sites and the admin user's or compliance officer's preferred site can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*",
"tags": [
"Recordings"
],
"parameters": [
{
"name": "max",
"in": "query",
"description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.",
"schema": {
"type": "number",
"default": 10
}
},
{
"name": "from",
"in": "query",
"description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days. If `to` is specified, the default value for `from` is `to` minus 7 days. If `to` is also not specified, the default value for `from` is current date and time minus 7 days.",
"example": "2020-07-12T09:30:00+08:00",
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days. If `from` is specified, the default value for `to` is `from` plus 7 days. If `from` is also not specified, the default value for `to` is the current date and time.",
"example": "2020-07-31T09:30:00+08:00",
"schema": {
"type": "string"
}
},
{
"name": "meetingId",
"in": "query",
"description": "Unique identifier for the parent meeting series, scheduled meeting, or meeting instance for which recordings are being requested. If a meeting series ID is specified, the operation returns an array of recordings for the specified meeting series. If a scheduled meeting ID is specified, the operation returns an array of recordings for the specified scheduled meeting. If a meeting instance ID is specified, the operation returns an array of recordings for the specified meeting instance. If not specified, the operation returns an array of recordings for all the current user's meetings. When `meetingId` is specified, the `siteUrl` parameter is ignored.",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"schema": {
"type": "string"
}
},
{
"name": "siteUrl",
"in": "query",
"description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.",
"example": "example.webex.com",
"schema": {
"type": "string"
}
},
{
"name": "integrationTag",
"in": "query",
"description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".",
"example": "dbaeceebea5c4a63ac9d5ef1edfe36b9",
"schema": {
"type": "string"
}
},
{
"name": "topic",
"in": "query",
"description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.",
"example": "John's Meeting",
"schema": {
"type": "string"
}
},
{
"name": "format",
"in": "query",
"description": "Recording's file format. If specified, the API filters recordings by format.",
"example": "ARF",
"schema": {
"type": "string",
"enum": [
"MP4",
"ARF"
]
}
},
{
"name": "serviceType",
"in": "query",
"description": "The service type for recordings. If specified, the API filters recordings by service type.",
"example": "MeetingCenter",
"schema": {
"type": "string",
"enum": [
"MeetingCenter",
"EventCenter",
"SupportCenter",
"TrainingCenter"
]
}
},
{
"name": "status",
"in": "query",
"description": "Recording's status. If not specified or `available`, retrieves recordings that are available. If specified as `deleted`, retrieves recordings that have been moved to the recycle bin. Otherwise, if specified as `purged`, retrieves recordings that have been purged from the recycle bin.",
"example": "available",
"schema": {
"type": "string",
"default": "available",
"enum": [
"available",
"deleted",
"purged"
]
}
},
{
"name": "timezone",
"in": "header",
"description": "e.g. UTC",
"required": false,
"schema": {
"type": "string"
},
"example": "UTC"
}
]
}
},
"/admin/recordings/{recordingId}": {
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found",
"headers": {},
"content": {}
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Delete a Recording By an Admin",
"operationId": "adminDeleteRecordingById",
"description": "Removes a recording with a specified recording ID by an admin. The deleted recording cannot be recovered. It will be inaccessible to regular users (host, attendees and shared) or an admin, but it will be still available to the Compliance Officer.\n\nAny recording on a site which is managed by the admin can be deleted by him.\n\nThe `temporaryDirectDownloadLinks` of a recording which are retrieved by the [Get Recording Details](/docs/api/v1/recordings/get-recording-details) API are still available to Compliance Officers even if the recording has been deleted.",
"tags": [
"Recordings"
],
"parameters": [
{
"name": "recordingId",
"in": "path",
"description": "A unique identifier for the recording.",
"required": true,
"example": "4f914b1dfe3c4d11a61730f18c0f5387",
"schema": {
"type": "string"
}
}
]
}
},
"/recordings/{recordingId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json;charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/RecordingObjectWithDirectDownloadLinks"
},
"example": {
"id": "4f914b1dfe3c4d11a61730f18c0f5387",
"meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
"meetingSeriesId": "f91b6edce9864428af084977b7c68291",
"topic": "Example Topic",
"createTime": "2020-07-13T17:11:35Z",
"timeRecorded": "2020-07-13T17:05:35Z",
"siteUrl": "site4-example.webex.com",
"downloadUrl": "https://site4-example.webex.com/site4/lsr.php?RCID=b91990e37417bda24986e46cf43345ab",
"playbackUrl": "https://site4-example.webex.com/site4/ldr.php?RCID=69201a61d1d94a84aca18817261d1a73",
"password": "********",
"temporaryDirectDownloadLinks": {
"recordingDownloadLink": "https://site4-example.webex.com/nbr/MultiThreadDownloadServlet?siteid=2062842&recordid=305462&confid=137735449369118342&language=en_US&userid=3516472&serviceRecordID=305492&ticket=SDJTSwAAAIUBSHkvL6Z5ddyBim5%2FHcJYcvn6IoXNEyCE2mAYQ5BlBg%3D%3D×tamp=1567125236465&islogin=yes&isprevent=no&ispwd=yes",
"audioDownloadLink": "https://site4-example.webex.com/nbr/downloadMedia.do?siteid=2062842&recordid=305462&confid=137735449369118342&language=en_US&userid=3516472&serviceRecordID=305492&ticket=SDJTSwAAAIXCIXsuBt%2BAgtK7WoQ2VhgeI608N4ZMIJ3vxQaQNZuLZA%3D%3D×tamp=1567125236708&islogin=yes&isprevent=no&ispwd=yes&mediaType=1",
"transcriptDownloadLink": "https://site4-example.webex.com/nbr/downloadMedia.do?siteid=2062842&recordid=305462&confid=137735449369118342&language=en_US&userid=3516472&serviceRecordID=305492&ticket=SDJTSwAAAAJVUJDxeA08qKkF%2FlxlSkDxuEFPwgGT0XW1z21NhY%2BCvg%3D%3D×tamp=1567125236866&islogin=yes&isprevent=no&ispwd=yes&mediaType=2",
"expiration": "2022-05-01T10:30:25Z"
},
"format": "ARF",
"serviceType": "MeetingCenter",
"durationSeconds": 18416,
"sizeBytes": 168103,
"shareToMe": false,
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"status": "available"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Recording Details",
"operationId": "getRecordByRecordId",
"description": "Retrieves details for a recording with a specified recording ID.\n\nOnly recordings of meetings hosted by or shared with the authenticated user may be retrieved.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*\n\n* `siteUrl`: Optional request header parameter. If specified, retrieve the recording details from that site; otherwise, retrieve it from the site which is implied based on the recording ID.",
"tags": [
"Recordings"
],
"parameters": [
{
"name": "recordingId",
"in": "path",
"description": "A unique identifier for the recording.",
"required": true,
"example": "4f914b1dfe3c4d11a61730f18c0f5387",
"schema": {
"type": "string"
}
},
{
"name": "hostEmail",
"in": "query",
"description": "Email address for the meeting host. Only used if the user or application calling the API has required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage, and the API will return recording details of that user.",
"example": "john.andersen@example.com",
"schema": {
"type": "string"
}
},
{
"name": "timezone",
"in": "header",
"description": "e.g. UTC",
"required": false,
"schema": {
"type": "string"
},
"example": "UTC"
},
{
"name": "siteUrl",
"in": "header",
"description": "e.g. example.webex.com",
"required": false,
"schema": {
"type": "string"
},
"example": "example.webex.com"
}
]
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found",
"headers": {},
"content": {}
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Delete a Recording",
"operationId": "deleteRecordingByRecordId",
"description": "Removes a recording with a specified recording ID. The deleted recording cannot be recovered. If a Compliance Officer deletes another user's recording, the recording will be inaccessible to regular users (host, attendees and shared), but will be still available to the Compliance Officer.\n\nOnly recordings of meetings hosted by the authenticated user can be deleted.\n\nThe `temporaryDirectDownloadLinks` of a recording which are retrieved by the [Get Recording Details](/docs/api/v1/recordings/get-recording-details) API are still available to Compliance Officers even if the recording has been deleted.",
"tags": [
"Recordings"
],
"parameters": [
{
"name": "recordingId",
"in": "path",
"description": "A unique identifier for the recording.",
"required": true,
"example": "4f914b1dfe3c4d11a61730f18c0f5387",
"schema": {
"type": "string"
}
},
{
"name": "hostEmail",
"in": "query",
"description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will delete a recording of that user.",
"example": "john.andersen@example.com",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"reason": "audit",
"comment": "Compliance Officer's optional explanation for deleting a recording"
},
"schema": {
"$ref": "#/components/schemas/DeleteRecordingObject"
}
}
}
}
}
},
"/recordings/softDelete": {
"post": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found",
"headers": {},
"content": {}
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Move Recordings into the Recycle Bin",
"operationId": "bulkSoftDeleteRecordings",
"description": "Move recordings into the recycle bin with recording IDs. Recordings in the recycle bin can be recovered by [Restore Recordings from Recycle Bin](/docs/api/v1/recordings/restore-recordings-from-recycle-bin) API. If you'd like to empty recordings from the recycle bin, you can use [Purge Recordings from Recycle Bin](/docs/api/v1/recordings/purge-recordings-from-recycle-bin) API to purge all or some of them.\n\nOnly recordings of meetings hosted by the authenticated user can be moved into the recycle bin.\n\n* `recordingIds` should not be empty and its maximum size is `100`.\n\n* All the IDs of `recordingIds` should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified.",
"tags": [
"Recordings"
],
"parameters": [
{
"name": "hostEmail",
"in": "query",
"description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will move recordings into recycle bin of that user",
"example": "john.andersen@example.com",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"recordingIds": [
"4f914b1dfe3c4d11a61730f18c0f5387"
],
"siteUrl": "example.webex.com"
},
"schema": {
"$ref": "#/components/schemas/BulkSoftDeleteRecordingObject"
}
}
}
}
}
},
"/recordings/restore": {
"post": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found",
"headers": {},
"content": {}
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Restore Recordings from Recycle Bin",
"operationId": "bulkRestoreRecordings",
"description": "Restore all or some recordings from the recycle bin. Only recordings of meetings hosted by the authenticated user can be restored from recycle bin.\n\n* If `restoreAll` is `true`, `recordingIds` should be empty.\n\n* If `restoreAll` is `false`, `recordingIds` should not be empty and its maximum size is `100`.\n\n* All the IDs of `recordingIds` should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified.",
"tags": [
"Recordings"
],
"parameters": [
{
"name": "hostEmail",
"in": "query",
"description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will restore recordings of that user.",
"example": "john.andersen@example.com",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"restoreAll": false,
"recordingIds": [
"4f914b1dfe3c4d11a61730f18c0f5387"
],
"siteUrl": "example.webex.com"
},
"schema": {
"$ref": "#/components/schemas/BulkRestoreRecordingObject"
}
}
}
}
}
},
"/recordings/purge": {
"post": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found",
"headers": {},
"content": {}
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Purge Recordings from Recycle Bin",
"operationId": "bulkPurgeRecordings",
"description": "Purge recordings from recycle bin with recording IDs or purge all the recordings that are in the recycle bin.\n\nOnly recordings of meetings hosted by the authenticated user can be purged from recycle bin.\n\n* If `purgeAll` is `true`, `recordingIds` should be empty.\n\n* If `purgeAll` is `false`, `recordingIds` should not be empty and its maximum size is `100`.\n\n* All the IDs of `recordingIds` should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified.",
"tags": [
"Recordings"
],
"parameters": [
{
"name": "hostEmail",
"in": "query",
"description": "Email address for the meeting host. Only used if the user or application calling the API has the required [admin-level meeting scopes](/docs/meetings#adminorganization-level-authentication-and-scopes). If set, the admin may specify the email of a user in a site they manage and the API will purge recordings from recycle bin of that user.",
"example": "john.andersen@example.com",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"purgeAll": false,
"recordingIds": [
"4f914b1dfe3c4d11a61730f18c0f5387"
],
"siteUrl": "example.webex.com"
},
"schema": {
"$ref": "#/components/schemas/BulkPurgeRecordingObject"
}
}
}
}
}
},
"/recordings/{recordingId}/accessList": {
"post": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found",
"headers": {},
"content": {}
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Share a Recording",
"operationId": "updateRecordingShareById",
"description": "Share or unshare a recording with other users by recording ID and email addresses.",
"tags": [
"Recordings"
],
"parameters": [
{
"name": "recordingId",
"in": "path",
"description": "A unique identifier for the recording.",
"required": true,
"example": "4f914b1dfe3c4d11a61730f18c0f5387",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"hostEmail": "john.andersen@example.com",
"addEmails": [
"alex@example.com",
"bob@example.com"
],
"removeEmails": [
"cherry@example.com",
"danielle@example.com"
],
"sendEmail": true
},
"schema": {
"$ref": "#/components/schemas/ShareRecordingByIdObject"
}
}
}
}
}
},
"/recordings/accessList": {
"post": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found",
"headers": {},
"content": {}
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Share a Recording Link",
"operationId": "updateRecordingShareByLink",
"description": "Share or unshare a recording with other users by recording link and email addresses.",
"tags": [
"Recordings"
],
"requestBody": {
"content": {
"application/json": {
"example": {
"webShareLink": "https://example.webex.com/webappng/sites/example/recording/9edff068a1cb4965ac640627161beed1/playback",
"hostEmail": "john.andersen@example.com",
"addEmails": [
"alex@example.com",
"bob@example.com"
],
"removeEmails": [
"cherry@example.com",
"danielle@example.com"
],
"sendEmail": true
},
"schema": {
"$ref": "#/components/schemas/ShareRecordingByLinkObject"
}
}
}
}
}
},
"/group/recordings": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Link": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json;charset=UTF-8": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecordingObject"
},
"description": "An array of recording objects."
}
}
},
"example": {
"items": [
{
"id": "4f914b1dfe3c4d11a61730f18c0f5387",
"meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
"meetingSeriesId": "f91b6edce9864428af084977b7c68291",
"topic": "Example Topic",
"createTime": "2020-07-13T17:11:35Z",
"timeRecorded": "2020-07-13T17:05:35Z",
"hostDisplayName": "John Andersen",
"hostEmail": "john.andersen@example.com",
"siteUrl": "site4-example.webex.com",
"downloadUrl": "https://site4-example.webex.com/site4/lsr.php?RCID=b91990e37417bda24986e46cf43345ab",
"playbackUrl": "https://site4-example.webex.com/site4/ldr.php?RCID=69201a61d1d94a84aca18817261d1a73",
"password": "********",
"format": "ARF",
"serviceType": "MeetingCenter",
"durationSeconds": 18416,
"sizeBytes": 168103,
"shareToMe": false,
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"status": "available"
},
{
"id": "3324fb76946249cfa07fc30b3ccbf580",
"meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
"meetingSeriesId": "f91b6edce9864428af084977b7c68291",
"topic": "Example Topic",
"createTime": "2020-07-13T17:11:34Z",
"timeRecorded": "2020-07-13T17:05:35Z",
"hostDisplayName": "John Andersen",
"hostEmail": "john.andersen@example.com",
"siteUrl": "site4-example.webex.com",
"downloadUrl": "https://site4-example.webex.com/site4/lsr.php?RCID=8a763939dec1fa26c565700d628fcb98",
"playbackUrl": "https://site4-example.webex.com/site4/ldr.php?RCID=b05e9c4f773745e7b88725cc97bc3161",
"password": "********",
"format": "ARF",
"serviceType": "MeetingCenter",
"durationSeconds": 181562,
"sizeBytes": 199134,
"shareToMe": false,
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"status": "available"
},
{
"id": "42b80117a2a74dcf9863bf06264f8075",
"meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
"meetingSeriesId": "f91b6edce9864428af084977b7c68291",
"topic": "Example Topic",
"createTime": "2020-07-13T17:11:33Z",
"timeRecorded": "2020-07-13T17:05:35Z",
"hostDisplayName": "John Andersen",
"hostEmail": "john.andersen@example.com",
"siteUrl": "site4-example.webex.com",
"downloadUrl": "https://site4-example.webex.com/site4/lsr.php?RCID=0edd48adbb183e7da97884a0a984e877",
"playbackUrl": "https://site4-example.webex.com/site4/ldr.php?RCID=b64b28ebf70e4645954420c295a9fcad",
"password": "********",
"format": "ARF",
"serviceType": "MeetingCenter",
"durationSeconds": 181562,
"sizeBytes": 199134,
"shareToMe": false,
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"status": "available"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Group Recordings",
"operationId": "listGroupRecordings",
"description": "List group recordings for a service app which has group recording access. You can specify a date range, the maximum number of recordings to return, and `personId` or `hostEmail` of whom the recordings will be retrieved.\n\n* The list returned is sorted in descending order by the date and time that the recordings were created.\n\n* Only recordings which are in the `available` status and not shared by others can be listed. Those in the `deleted` or `purged` status or shared by others can't be listed.\n\n* Long result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the API lists group recordings on the specified site; otherwise, the API lists group recordings on all the sites managed by the service app. All the sites managed by a service app can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.\n\n* One of the `personId` parameter and `hostEmail` header must be specified so that only recordings of meetings hosted by the person of `personId` or `hostEmail` will be returned.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.\n\n* `hostEmail`: Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.",
"tags": [
"Recordings"
],
"parameters": [
{
"name": "personId",
"in": "query",
"description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.",
"required": false,
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk",
"schema": {
"type": "string"
}
},
{
"name": "max",
"in": "query",
"description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`.",
"schema": {
"type": "number",
"default": 10
}
},
{
"name": "from",
"in": "query",
"description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days.",
"example": "2020-07-12T09:30:00+08:00",
"schema": {
"type": "string",
"default": "If only `to` is specified, the default `from` value is 7 days before `to`; if no `to` or `from` is specified, the default `from` value is 7 days before current date and time."
}
},
{
"name": "to",
"in": "query",
"description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days.",
"example": "2020-07-31T09:30:00+08:00",
"schema": {
"type": "string",
"default": "If `from` is specified, the default value is 7 days after `from`; if `from` is not specified, the default value is the current date and time."
}
},
{
"name": "siteUrl",
"in": "query",
"description": "URL of the Webex site which the API lists recordings from. If not specified, the API lists recordings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.",
"example": "example.webex.com",
"schema": {
"type": "string"
}
},
{
"name": "integrationTag",
"in": "query",
"description": "External key of the parent meeting created by an integration application. This parameter is used by the integration application to query recordings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc. An integrationTag created by one client cannot be accessed or used as a filtering parameter by another client. For example, if a meeting has an `integrationTag` of \"Sales\" which is created by the client behind the developer portal, then this integrationTag can't be accessed on the meeting or its recordings by another client. Neither can it be used to filter meetings or recordings by a client other than the one that created the integrationTag of \"Sales\".",
"example": "dbaeceebea5c4a63ac9d5ef1edfe36b9",
"schema": {
"type": "string"
}
},
{
"name": "topic",
"in": "query",
"description": "Recording topic. If specified, the API filters recordings by topic in a case-insensitive manner.",
"example": "John's Meeting",
"schema": {
"type": "string"
}
},
{
"name": "format",
"in": "query",
"description": "Recording's file format. If specified, the API filters recordings by format.",
"example": "ARF",
"schema": {
"type": "string",
"enum": [
"MP4",
"ARF"
]
}
},
{
"name": "serviceType",
"in": "query",
"description": "The service type for recordings. If specified, the API filters recordings by service type.",
"example": "MeetingCenter",
"schema": {
"type": "string",
"enum": [
"MeetingCenter",
"EventCenter",
"SupportCenter",
"TrainingCenter"
]
}
},
{
"name": "timezone",
"in": "header",
"description": "e.g. UTC",
"required": false,
"schema": {
"type": "string"
},
"example": "UTC"
},
{
"name": "hostEmail",
"in": "header",
"description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.",
"required": false,
"schema": {
"type": "string"
},
"example": "john.andersen@example.com"
}
]
}
},
"/group/recordings/{recordingId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json;charset=UTF-8": {
"schema": {
"$ref": "#/components/schemas/RecordingObjectWithDirectDownloadLinks"
},
"example": {
"id": "4f914b1dfe3c4d11a61730f18c0f5387",
"meetingId": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"scheduledMeetingId": "f91b6edce9864428af084977b7c68291_20200713T121500Z",
"meetingSeriesId": "f91b6edce9864428af084977b7c68291",
"topic": "Example Topic",
"createTime": "2020-07-13T17:11:35Z",
"timeRecorded": "2020-07-13T17:05:35Z",
"siteUrl": "site4-example.webex.com",
"downloadUrl": "https://site4-example.webex.com/site4/lsr.php?RCID=b91990e37417bda24986e46cf43345ab",
"playbackUrl": "https://site4-example.webex.com/site4/ldr.php?RCID=69201a61d1d94a84aca18817261d1a73",
"password": "********",
"temporaryDirectDownloadLinks": {
"recordingDownloadLink": "https://site4-example.webex.com/nbr/MultiThreadDownloadServlet?siteid=2062842&recordid=305462&confid=137735449369118342&language=en_US&userid=3516472&serviceRecordID=305492&ticket=SDJTSwAAAIUBSHkvL6Z5ddyBim5%2FHcJYcvn6IoXNEyCE2mAYQ5BlBg%3D%3D×tamp=1567125236465&islogin=yes&isprevent=no&ispwd=yes",
"audioDownloadLink": "https://site4-example.webex.com/nbr/downloadMedia.do?siteid=2062842&recordid=305462&confid=137735449369118342&language=en_US&userid=3516472&serviceRecordID=305492&ticket=SDJTSwAAAIXCIXsuBt%2BAgtK7WoQ2VhgeI608N4ZMIJ3vxQaQNZuLZA%3D%3D×tamp=1567125236708&islogin=yes&isprevent=no&ispwd=yes&mediaType=1",
"transcriptDownloadLink": "https://site4-example.webex.com/nbr/downloadMedia.do?siteid=2062842&recordid=305462&confid=137735449369118342&language=en_US&userid=3516472&serviceRecordID=305492&ticket=SDJTSwAAAAJVUJDxeA08qKkF%2FlxlSkDxuEFPwgGT0XW1z21NhY%2BCvg%3D%3D×tamp=1567125236866&islogin=yes&isprevent=no&ispwd=yes&mediaType=2",
"expiration": "2022-05-01T10:30:25Z"
},
"format": "ARF",
"serviceType": "MeetingCenter",
"durationSeconds": 18416,
"sizeBytes": 168103,
"shareToMe": false,
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"status": "available"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Group Recording Details",
"operationId": "getGroupRecordingById",
"description": "Retrieves details for a group recording for a service app which has group recording access.\n\n* Only recordings which are in the `available` status and not shared by others can be listed. Those in the `deleted` or `purged` status or shared by others can't be listed.\n\n* One of the `personId` parameter and `hostEmail` header must be specified so that only recordings of meetings hosted by the person of `personId` or `hostEmail` will be returned.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined.*\n\n* `hostEmail`: Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.",
"tags": [
"Recordings"
],
"parameters": [
{
"name": "personId",
"in": "query",
"description": "Person ID of the user whose recordings will be retrieved. The person ID can be retrieved from the [People APIs](/docs/api/v1/people), e.g. [Lit People](/docs/api/v1/people/list-people). Note that a person ID retrieved from the People APIs is a Base64-encoded string, e.g. `Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk`. The person ID in the raw UUID format which is the last part of the Base64-decoded string, e.g. `d47b2e7d-5e0f-4f69-aef4-e4ff90aea7c9`, is also supported. The `personId` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.",
"required": false,
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNDdiMmU3ZC01ZTBmLTRmNjktYWVmNC1lNGZmOTBhZWE3Yzk",
"schema": {
"type": "string"
}
},
{
"name": "recordingId",
"in": "path",
"description": "A unique identifier for the recording.",
"required": true,
"example": "4f914b1dfe3c4d11a61730f18c0f5387",
"schema": {
"type": "string"
}
},
{
"name": "timezone",
"in": "header",
"description": "e.g. UTC",
"required": false,
"schema": {
"type": "string"
},
"example": "UTC"
},
{
"name": "hostEmail",
"in": "header",
"description": "Email of the user whose recordings will be retrieved. The `hostEmail` parameter is optional, but one of the `personId` parameter and `hostEmail` header must be specified.",
"required": false,
"schema": {
"type": "string"
},
"example": "john.andersen@example.com"
}
]
}
},
"/report/templates": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Template"
}
},
"example": {
"items": [
{
"Id": 130,
"title": "Client Version Prod",
"service": "Teams",
"maxDays": 31,
"identifier": "orgWithoutDate",
"validations": [
{
"field": "templateId",
"required": "yes"
}
]
}
],
"numberOfTemplate": 1
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Report Templates",
"operationId": "List Report Templates",
"description": "List all the available report templates that can be generated.\n\nCSV (comma separated value) reports for Webex services are only supported for organizations based in the North American region. Organizations based in other regions will return blank CSV files for any Webex reports.\n\n#### Validation Fields\n\nEach template includes validation rules that specify which fields are required when generating a report using the [Reports API](/docs/api/v1/reports). The possible validation field values are:\n\n- **templateId**: The unique identifier of the report template to use. This is always required when creating a report.\n- **siteList**: A comma-separated list of Webex sites (e.g., \"cisco.webex.com\"). Required for site-based templates, typically for Webex Meetings reports.\n- **subIds**: Subscription IDs for the report. Required for certain enterprise agreement templates, particularly for Webex Onboarding service reports.\n- **startDate**: The start date for the report data range in YYYY-MM-DD format. Required for date-range based templates.\n- **endDate**: The end date for the report data range in YYYY-MM-DD format. Required for date-range based templates.\n\nWhen creating a report, ensure you provide all fields marked as \"required\": \"yes\" in the template's validation rules.",
"tags": [
"Report Templates"
],
"parameters": []
}
},
"/reports": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportCollectionResponse"
},
"example": {
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL1JFUE9SVC9hZDBkMjA1NzVkYTA0NWE0OGZhZDQ3ZDk3NGFiNDFmMg",
"service": "Teams",
"startDate": "2020-03-17",
"endDate": "2020-03-18",
"siteList": "",
"created": "2020-05-27 17:02:43",
"createdBy": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
"scheduleFrom": "api",
"status": "done",
"reportTitle": "Bots Activity",
"downloadURL": "https://downloadservicebts.webex.com/api?reportId=Y2lzY29zcGFyazovL3VzL1JFUE9SVC9hZDBkMjA1NzVkYTA0NWE0OGZhZDQ3ZDk3NGFiNDFmMg"
}
],
"numberOfReports": 1
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Reports",
"operationId": "listReports",
"description": "Lists all reports. Use query parameters to filter the response. The parameters are optional. However, `from` and `to` parameters should be provided together.\n\n**Notes**:\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.\n\nReports are usually provided in zip format. A Content-header `application/zip` or `application/octet-stream` does indicate the zip format. There is usually no .zip file extension.",
"tags": [
"Reports"
],
"parameters": [
{
"name": "reportId",
"in": "query",
"description": "List reports by ID.",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
"schema": {
"type": "string"
}
},
{
"name": "service",
"in": "query",
"description": "List reports which use this service.",
"example": "Webex",
"schema": {
"type": "string"
}
},
{
"name": "templateId",
"in": "query",
"description": "List reports with this report template ID.",
"example": 5,
"schema": {
"type": "number"
}
},
{
"name": "from",
"in": "query",
"description": "List reports that were created on or after this date.",
"example": "2020-05-01",
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"description": "List reports that were created before this date.",
"example": "2020-05-05",
"schema": {
"type": "string"
}
}
]
},
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
"description": "The unique identifier for the report."
}
}
},
"example": {
"items": {
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE"
}
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Create a Report",
"operationId": "createaReport",
"description": "Create a new report. For each `templateId`, there are a set of validation rules that need to be followed. For example, for templates belonging to Webex, the user needs to provide `siteUrl`. These validation rules can be retrieved via the [Report Templates API](/docs/api/v1/report-templates).\n\nThe 'templateId' parameter is a number. However, it is a limitation of developer.webex.com platform that it is passed as a string when you try to test the API from here.\n\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.",
"tags": [
"Reports"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"templateId"
],
"properties": {
"templateId": {
"type": "number",
"example": 5,
"description": "Unique ID representing valid report templates."
},
"startDate": {
"type": "string",
"example": "2020-05-01",
"description": "Data in the report will be from this date onwards."
},
"endDate": {
"type": "string",
"example": "2020-05-05",
"description": "Data in the report will be until this date."
},
"siteList": {
"type": "string",
"example": "cisco.webex.com",
"description": "Sites belonging to user's organization. This attribute is needed for site-based templates."
}
}
}
}
}
}
}
},
"/reports/{reportId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Report"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
"title": "Bots Activity",
"service": "Teams",
"startDate": "2020-02-23",
"endDate": "2020-03-24",
"siteList": "cisco.webex.com",
"created": "2020-03-24 17:13:39",
"createdBy": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
"scheduledFrom": "API",
"status": "done",
"downloadURL": "https://downloadservicebts.webex.com/api?reportId=Y2lzY29zcGFyazovL3VzL1JFUE9SVC9hZDBkMjA1NzVkYTA0NWE0OGZhZDQ3ZDk3NGFiNDFmMg"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Report Details",
"operationId": "getReportDetails",
"description": "Shows details for a report, by report ID.\n\nSpecify the report ID in the `reportId` parameter in the URI.\n\n**Notes**:\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.\n\nReports are usually provided in zip format. A Content-header `application/zip` or `application/octet-stream` does indicate the zip format. There is usually no .zip file extension.",
"tags": [
"Reports"
],
"parameters": [
{
"name": "reportId",
"in": "path",
"description": "The unique identifier for the report.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
"schema": {
"type": "string"
}
}
]
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Delete a Report",
"operationId": "deleteAReport",
"description": "Remove a report from the system.\n\nSpecify the report ID in the `reportId` parameter in the URI\n\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.",
"tags": [
"Reports"
],
"parameters": [
{
"name": "reportId",
"in": "path",
"description": "The unique identifier for the report.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
"schema": {
"type": "string"
}
}
]
}
},
"/resourceGroup/memberships": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Link": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceGroupMembershipCollectionResponse"
},
"example": {
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQX01FTUJFUlNISVAvcGVyc29uSWQ6bGljZW5zZUlk",
"resourceGroupId": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQL2RlZmF1bHQ",
"licenseId": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvMWNjYmJjMTctZDYxNi00ZDc0LTg2NGItYjFmM2IwNzAxZmJhOk1TXzAzMDRjMDkzLTFjM2MtNDRlMC1iYjBhLWU1ZDE2NDM2NmQ1OQ",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"personOrgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"status": "activated"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Resource Group Memberships",
"operationId": "List Resource Group Memberships",
"description": "Lists all resource group memberships for an organization.\n\nUse query parameters to filter the response.",
"tags": [
"Resource Group Memberships"
],
"parameters": [
{
"name": "licenseId",
"in": "query",
"description": "List resource group memberships for a license, by ID.",
"example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvMWNjYmJjMTctZDYxNi00ZDc0LTg2NGItYjFmM2IwNzAxZmJhOk1TXzAzMDRjMDkzLTFjM2MtNDRlMC1iYjBhLWU1ZDE2NDM2NmQ1OQ",
"schema": {
"type": "string"
}
},
{
"name": "personId",
"in": "query",
"description": "List resource group memberships for a person, by ID.",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZWZiNWVkMC0wY2FmLTRiNTYtYmMxMS03MzhlOWRhMDU5MjM",
"schema": {
"type": "string"
}
},
{
"name": "personOrgId",
"in": "query",
"description": "List resource group memberships for an organization, by ID.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "Limit resource group memberships to a specific status.",
"example": "activated",
"schema": {
"type": "string",
"enum": [
"pending",
"activated",
"error"
]
}
},
{
"name": "max",
"in": "query",
"description": "Limit the maximum number of resource group memberships in the response.",
"example": "100",
"schema": {
"type": "number",
"default": 100
}
}
]
}
},
"/resourceGroup/memberships/v2": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Link": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceGroupMembershipCollectionResponse"
},
"example": {
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQX01FTUJFUlNISVAvcGVyc29uSWQ6bGljZW5zZUlk",
"resourceGroupId": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQL2RlZmF1bHQ",
"licenseId": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvMWNjYmJjMTctZDYxNi00ZDc0LTg2NGItYjFmM2IwNzAxZmJhOk1TXzAzMDRjMDkzLTFjM2MtNDRlMC1iYjBhLWU1ZDE2NDM2NmQ1OQ",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"personOrgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"status": "activated"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Resource Group Memberships V2",
"operationId": "listResourceGroupMembershipsV2",
"description": "Lists all resource group memberships for an organization having filtering option based on entity type (User / Workspace).\n\nUse query parameters to filter the response.",
"tags": [
"Resource Group Memberships"
],
"parameters": [
{
"name": "licenseId",
"in": "query",
"description": "List resource group memberships for a license, by ID.",
"example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvMWNjYmJjMTctZDYxNi00ZDc0LTg2NGItYjFmM2IwNzAxZmJhOk1TXzAzMDRjMDkzLTFjM2MtNDRlMC1iYjBhLWU1ZDE2NDM2NmQ1OQ",
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "query",
"description": "List resource group memberships by ID.",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZWZiNWVkMC0wY2FmLTRiNTYtYmMxMS03MzhlOWRhMDU5MjM",
"schema": {
"type": "string"
}
},
{
"name": "orgId",
"in": "query",
"description": "List resource group memberships for an organization, by ID.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "Limit resource group memberships to a specific status.",
"example": "activated",
"schema": {
"type": "string",
"enum": [
"pending",
"activated",
"error"
]
}
},
{
"name": "type",
"in": "query",
"description": "List resource group memberships for an organization, by type. If left blank it will include both User and Workspace type.",
"example": "User",
"schema": {
"type": "string",
"enum": [
"User",
"Workspace"
]
}
},
{
"name": "max",
"in": "query",
"description": "Limit the maximum number of resource group memberships in the response.",
"example": 100,
"schema": {
"type": "number",
"default": 100
}
}
]
}
},
"/resourceGroup/memberships/{resourceGroupMembershipId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceGroupMembership"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQX01FTUJFUlNISVAvcGVyc29uSWQ6bGljZW5zZUlk",
"resourceGroupId": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQL2RlZmF1bHQ",
"licenseId": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvMWNjYmJjMTctZDYxNi00ZDc0LTg2NGItYjFmM2IwNzAxZmJhOk1TXzAzMDRjMDkzLTFjM2MtNDRlMC1iYjBhLWU1ZDE2NDM2NmQ1OQ",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"personOrgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"status": "activated"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Resource Group Membership Details",
"operationId": "Get Resource Group Membership Details",
"description": "Shows details for a resource group membership, by ID.\n\nSpecify the resource group membership ID in the `resourceGroupMembershipId` URI parameter.",
"tags": [
"Resource Group Memberships"
],
"parameters": [
{
"name": "resourceGroupMembershipId",
"in": "path",
"description": "The unique identifier for the resource group membership.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQX01FTUJFUlNISVAvcGVyc29uSWQ6bGljZW5zZUlk",
"schema": {
"type": "string"
}
}
]
},
"put": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceGroupMembership"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQX01FTUJFUlNISVAvcGVyc29uSWQ6bGljZW5zZUlk",
"resourceGroupId": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQL2RlZmF1bHQ",
"licenseId": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvMWNjYmJjMTctZDYxNi00ZDc0LTg2NGItYjFmM2IwNzAxZmJhOk1TXzAzMDRjMDkzLTFjM2MtNDRlMC1iYjBhLWU1ZDE2NDM2NmQ1OQ",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"personOrgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"status": "activated"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Update a Resource Group Membership",
"operationId": "Update a Resource Group Membership",
"description": "Updates a resource group membership, by ID.\n\nSpecify the resource group membership ID in the `resourceGroupMembershipId`Â URI parameter.\n\nOnly the `resourceGroupId`Â can be changed with this action. Resource group memberships with a `status`Â of \"pending\" cannot be updated. For more information about resource group memberships, see the [Managing Hybrid Services](/docs/api/guides/managing-hybrid-services-licenses#webex-resource-groups) guide.",
"tags": [
"Resource Group Memberships"
],
"parameters": [
{
"name": "resourceGroupMembershipId",
"in": "path",
"description": "The unique identifier for the resource group membership.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQX01FTUJFUlNISVAvcGVyc29uSWQ6bGljZW5zZUlk",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"resourceGroupId": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQL2RlZmF1bHQ",
"licenseId": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvMWNjYmJjMTctZDYxNi00ZDc0LTg2NGItYjFmM2IwNzAxZmJhOk1TXzAzMDRjMDkzLTFjM2MtNDRlMC1iYjBhLWU1ZDE2NDM2NmQ1OQ",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"personOrgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"status": "activated"
},
"schema": {
"type": "object",
"required": [
"resourceGroupId",
"licenseId",
"personId",
"personOrgId",
"status"
],
"properties": {
"resourceGroupId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQL2RlZmF1bHQ",
"description": "The resource group ID."
},
"licenseId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvMWNjYmJjMTctZDYxNi00ZDc0LTg2NGItYjFmM2IwNzAxZmJhOk1TXzAzMDRjMDkzLTFjM2MtNDRlMC1iYjBhLWU1ZDE2NDM2NmQ1OQ",
"description": "The license ID."
},
"personId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"description": "The person ID."
},
"personOrgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The organization ID of the person."
},
"status": {
"type": "string",
"enum": [
"pending",
"activated",
"error"
],
"description": "The activation status of the resource group membership.\n * `pending` - activation pending\n * `activated` - activated\n * `error` - error present\n"
}
}
}
}
}
}
}
},
"/resourceGroups": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceGroupCollectionResponse"
},
"example": {
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQL2RlZmF1bHQ",
"name": "Resource Group 1",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Resource Groups",
"operationId": "List Resource Groups",
"description": "List resource groups.\n\nUse query parameters to filter the response.",
"tags": [
"Resource Groups"
],
"parameters": [
{
"name": "orgId",
"in": "query",
"description": "List resource groups in this organization. Only admin users of another organization (such as partners) may use this parameter.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"schema": {
"type": "string"
}
}
]
}
},
"/resourceGroups/{resourceGroupId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceGroup"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQL2RlZmF1bHQ",
"name": "Resource Group 1",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Resource Group Details",
"operationId": "Get Resource Group Details",
"description": "Shows details for a resource group, by ID.\n\nSpecify the resource group ID in the `resourceGroupId` parameter in the URI.",
"tags": [
"Resource Groups"
],
"parameters": [
{
"name": "resourceGroupId",
"in": "path",
"description": "The unique identifier for the resource group.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQL2RlZmF1bHQ",
"schema": {
"type": "string"
}
}
]
}
},
"/roles": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleCollectionResponse"
},
"example": {
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"name": "Full Administrator"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Roles",
"operationId": "List Roles",
"description": "List all roles. Must be called by an admin user.",
"tags": [
"Roles"
],
"parameters": []
}
},
"/roles/{roleId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"name": "Full Administrator"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Role Details",
"operationId": "Get Role Details",
"description": "Shows details for a role, by ID.\n\nSpecify the role ID in the `roleId` parameter in the URI.",
"tags": [
"Roles"
],
"parameters": [
{
"name": "roleId",
"in": "path",
"description": "The unique identifier for the role.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"schema": {
"type": "string"
}
}
]
}
},
"/identity/scim/{orgId}/v2/Bulk": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkUser"
},
"example": {
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:BulkResponse"
],
"Operations": [
{
"location": "https://example.com/v2/Users/92b725cd-9465-4e7d-8c16-01f8e146b87a",
"method": "POST",
"bulkId": "qwerty",
"version": "W/\"oY4m4wn58tkVjJxK\"",
"status": "201"
},
{
"location": "https://example.com/v2/Users/5d8d29d3-342c-4b5f-8683-a3cb6763ffcc",
"method": "PATCH",
"version": "W/\"huJj29dMNgu3WXPD\"",
"status": "200"
},
{
"location": "https://example.com/v2/Users/e9025315-6bea-44e1-899c-1e07454e468b",
"method": "DELETE",
"status": "204"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "User bulk API",
"operationId": "User bulk API",
"description": "
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\n**Usage**:\n\n1. The input JSON must conform to the following schema: 'urn:ietf:params:scim:api:messages:2.0:BulkRequest'.\n\n1. The request must be accompanied with a body in JSON format according to the standard SCIM schema definition.\n The maximum number of operations in a request is 100; an error is thrown if the limit is exceeded.\n\n1. `failOnErrors` parameter\n\n An integer specifies the number of errors that the service provider will accept before the operation is terminated and an error response is returned.\n It is OPTIONAL in a request.\n Maximum number of operations allowed to fail before the server stops processing the request. The value must be between 1 and 100.\n\n1. `operations` parameter\n\n Contains a list of bulk operations for POST/PATCH/DELETE operations. (REQUIRED)\n + `operations.method`\n\n The HTTP method of the current operation. Possible values are POST, PATCH or DELETE.\n + `operations.path`\n\n The Resource's relative path. If the method is POST the value must specify a Resource type endpoint;\n e.g., /Users or /Groups whereas all other method values must specify the path to a specific Resource;\n e.g., /Users/2819c223-7f76-453a-919d-413861904646.\n + `operations.data`\n\n The Resource data as it would appear for a single POST or PATCH Resource operation.\n It is REQUIRED in a request when method is POST and PATCH.\n Refer to corresponding wiki for SCIM 2.0 POST, PATCH and DELETE API.\n + `operations.bulkId`\n\n The transient identifier of a newly created resource, unique within a bulk request and created by the client.\n The bulkId serves as a surrogate resource id enabling clients to uniquely identify newly created resources in the response and cross-reference new resources in and across operations within a bulk request.\n It is REQUIRED when \"method\" is \"POST\".",
"tags": [
"Bulk Manage SCIM 2 Users and Groups"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Webex Identity assigned organization identifier for user's organization.",
"required": true,
"example": "0ae87ade-8c8a-4952-af08-318798958d0c",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:BulkRequest"
],
"failOnErrors": 99,
"operations": [
{
"method": "PATCH",
"path": "/Users/2819c223-7f76-453a-919d-413861904646",
"data": "JSON text",
"bulkId": "ytrewq"
}
]
},
"schema": {
"$ref": "#/components/schemas/BulkUser"
}
}
}
}
}
},
"/identity/scim/{orgId}/v2/Groups": {
"post": {
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetGroupResponse"
},
"example": {
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group"
],
"id": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"displayName": "wade_test_ccbeca2c-5f25-4c3a-b03c-e3bbc5368405@webex.identity.com",
"externalId": "test",
"members": [
{
"value": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
"type": "user",
"example": "https://example.com/v2/Users/c5349664-9f3d-410b-8bd3-6c31f181f13d",
"display": "A user"
},
{
"value": "ffd2164c-b938-46dd-8b2f-def6c33b45d0",
"type": "group",
"example": "https://example.com/v2/Groups/ffd2164c-b938-46dd-8b2f-def6c33b45d0",
"display": "A nested group"
}
],
"meta": {
"resourceType": "group",
"created": "2011-08-01T21:32:44.882Z",
"lastModified": "2011-08-01T21:32:44.882Z",
"version": "W/\"e180ee84f0671b1\"",
"location": "https://example.com/v2/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a"
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group": {
"usage": "location",
"inheritances": [
{
"type": "role",
"value": "id_full_admin",
"nested": false,
"scope": [
"user"
]
}
],
"owners": [
{
"value": "bb9e77e5-91c3-4006-87c7-c18d885174c7"
},
{
"value": "93e10e81-f836-434c-8e4c-8f496aeef8d5"
}
],
"managedBy": [
{
"orgId": "e82f0522-09b1-49fb-9fff-735fee313456",
"type": "user",
"id": "0f0c3024-73dc-4e1f-b4b0-f47e67c0399c",
"role": "location_full_admin"
},
{
"orgId": "cd828192-269c-4bc7-943b-273555227961",
"type": "machine",
"id": "4ecec95a-0493-4df0-bd1c-c97712561077",
"role": "id_user_admin"
}
],
"provisionSource": "AD",
"meta": {
"organizationID": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6"
}
}
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Create a group",
"operationId": "Create a group",
"description": "Create a new group for a given organization. The group may optionally be created with group members.\n\n
\n\n**Authorization**\n\nOAuth token returned by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n
\n\n**Usage**:\n\n1. The input JSON must conform to one of the following schemas:\n - `urn:ietf:params:scim:schemas:core:2.0:Group`\n - `urn:scim:schemas:extension:cisco:webexidentity:2.0:Group`\n\n1. Unrecognized schemas (ID/section) are ignored.\n\n1. Read-only attributes provided as input values are ignored.",
"tags": [
"SCIM 2 Groups"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.",
"required": true,
"example": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group"
],
"displayName": "group1@example.com",
"externalId": "test",
"members": [
{
"value": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
"type": "user"
}
],
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group": {
"usage": "policy",
"inheritances": [
{
"type": "role",
"value": "id_full_admin",
"nested": false,
"scope": [
"user"
]
}
],
"owners": [
{
"value": "c5349664-9f3d-410b-8bd3-6c31f181f13d"
}
],
"managedBy": [
{
"orgId": "d1349664-9f3d-410b-8bd3-6c31f181f14e",
"type": "user",
"id": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
"role": "location_full_admin"
}
]
}
},
"schema": {
"$ref": "#/components/schemas/PostGroup"
}
}
}
}
},
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchGroupResponse"
},
"example": {
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 2,
"itemsPerPage": 2,
"startIndex": 1,
"Resources": [
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group"
],
"id": "6d26ba8b-8a07-465c-8e1a-c283eea9b4fd",
"displayName": "wade_test_ccbeca2c-5f25-4c3a-b03c-e3bbc5368405@webex.identity.com",
"externalId": "test",
"members": [
{
"value": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
"type": "user",
"example": "https://example.com/v2/Users/c5349664-9f3d-410b-8bd3-6c31f181f13d",
"display": "A user"
},
{
"value": "ffd2164c-b938-46dd-8b2f-def6c33b45d0",
"type": "group",
"example": "https://example.com/v2/Groups/ffd2164c-b938-46dd-8b2f-def6c33b45d0",
"display": "A nested group"
}
],
"meta": {
"resourceType": "group",
"created": "2011-08-01T21:32:44.882Z",
"lastModified": "2011-08-01T21:32:44.882Z",
"version": "W/\"e180ee84f0671b1\"",
"location": "https://example.com/v2/Groups/6d26ba8b-8a07-465c-8e1a-c283eea9b4fd"
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group": {
"usage": "location",
"inheritances": [
{
"type": "role",
"value": "id_full_admin",
"nested": false,
"scope": [
"user"
]
}
],
"owners": [
{
"value": "bb9e77e5-91c3-4006-87c7-c18d885174c7"
},
{
"value": "93e10e81-f836-434c-8e4c-8f496aeef8d5"
}
],
"managedBy": [
{
"orgId": "e82f0522-09b1-49fb-9fff-735fee313456",
"type": "user",
"id": "0f0c3024-73dc-4e1f-b4b0-f47e67c0399c",
"role": "location_full_admin"
},
{
"orgId": "cd828192-269c-4bc7-943b-273555227961",
"type": "Machine",
"id": "4ecec95a-0493-4df0-bd1c-c97712561077",
"role": "id_user_admin"
}
],
"provisionSource": "AD",
"meta": {
"organizationID": "4859c223-7f76-453a-919d-4138645454546"
}
}
},
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group"
],
"id": "89ef7711-0d50-469f-8eb7-8ef47da7102f",
"displayName": "wade_test_ccbeca2c-5f25-4c3a-b03c-e3bbc5368405@webex.identity.com",
"externalId": "test",
"members": [
{
"value": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
"type": "user",
"example": "https://example.com/v2/Users/c5349664-9f3d-410b-8bd3-6c31f181f13d",
"display": "A user"
},
{
"value": "ffd2164c-b938-46dd-8b2f-def6c33b45d0",
"type": "group",
"example": "https://example.com/v2/Groups/ffd2164c-b938-46dd-8b2f-def6c33b45d0",
"display": "A nested group"
}
],
"meta": {
"resourceType": "group",
"created": "2011-08-01T21:32:44.882Z",
"lastModified": "2011-08-01T21:32:44.882Z",
"version": "W/\"e180ee84f0671b1\"",
"location": "https://example.com/v2/Groups/89ef7711-0d50-469f-8eb7-8ef47da7102f"
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group": {
"usage": "location",
"owners": [
{
"value": "bb9e77e5-91c3-4006-87c7-c18d885174c7"
},
{
"value": "93e10e81-f836-434c-8e4c-8f496aeef8d5"
}
],
"managedBy": [
{
"orgId": "e82f0522-09b1-49fb-9fff-735fee313456",
"type": "user",
"id": "0f0c3024-73dc-4e1f-b4b0-f47e67c0399c",
"role": "location_full_admin"
},
{
"orgId": "cd828192-269c-4bc7-943b-273555227961",
"type": "Machine",
"id": "4ecec95a-0493-4df0-bd1c-c97712561077",
"role": "id_user_admin"
}
],
"provisionSource": "AD",
"meta": {
"organizationID": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6"
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Search groups",
"operationId": "Search groups",
"description": "Retrieve a list of groups in the organization.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n
\n\n**Authorization**\n\nAn OAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`",
"tags": [
"SCIM 2 Groups"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.",
"required": true,
"example": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.\n",
"example": "displayName Eq \"group1%40example.com \" or displayName Eq \"group2%40example.com \"",
"schema": {
"type": "string"
}
},
{
"name": "attributes",
"in": "query",
"description": "The attributes to return.",
"example": "displayName",
"schema": {
"type": "string"
}
},
{
"name": "excludedAttributes",
"in": "query",
"description": "Attributes to be excluded from the return.",
"example": "members",
"schema": {
"type": "string"
}
},
{
"name": "sortBy",
"in": "query",
"description": "A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.",
"example": "displayName",
"schema": {
"type": "string"
}
},
{
"name": "sortOrder",
"in": "query",
"description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.",
"example": "ascending",
"schema": {
"type": "string"
}
},
{
"name": "startIndex",
"in": "query",
"description": "An integer indicating the 1-based index of the first query result. The default is 1.",
"example": 1,
"schema": {
"type": "number"
}
},
{
"name": "count",
"in": "query",
"description": "An integer indicating the desired maximum number of query results per page. The default is 100.",
"example": 10,
"schema": {
"type": "number"
}
},
{
"name": "includeMembers",
"in": "query",
"description": "Default \"false\". If false, no members returned.",
"example": false,
"schema": {
"type": "boolean"
}
},
{
"name": "memberType",
"in": "query",
"description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.",
"example": "user",
"schema": {
"type": "string"
}
}
]
}
},
"/identity/scim/{orgId}/v2/Groups/{groupId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetGroupResponse"
},
"example": {
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group"
],
"id": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"displayName": "wade_test_ccbeca2c-5f25-4c3a-b03c-e3bbc5368405@webex.identity.com",
"externalId": "test",
"members": [
{
"value": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
"type": "user",
"example": "https://example.com/v2/Users/c5349664-9f3d-410b-8bd3-6c31f181f13d",
"display": "A user"
},
{
"value": "ffd2164c-b938-46dd-8b2f-def6c33b45d0",
"type": "group",
"example": "https://example.com/v2/Groups/ffd2164c-b938-46dd-8b2f-def6c33b45d0",
"display": "A nested group"
}
],
"meta": {
"resourceType": "group",
"created": "2011-08-01T21:32:44.882Z",
"lastModified": "2011-08-01T21:32:44.882Z",
"version": "W/\"e180ee84f0671b1\"",
"location": "https://example.com/v2/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a"
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group": {
"usage": "location",
"inheritances": [
{
"type": "role",
"value": "id_full_admin",
"nested": false,
"scope": [
"user"
]
}
],
"owners": [
{
"value": "bb9e77e5-91c3-4006-87c7-c18d885174c7"
},
{
"value": "93e10e81-f836-434c-8e4c-8f496aeef8d5"
}
],
"managedBy": [
{
"orgId": "e82f0522-09b1-49fb-9fff-735fee313456",
"type": "user",
"id": "0f0c3024-73dc-4e1f-b4b0-f47e67c0399c",
"role": "location_full_admin"
},
{
"orgId": "cd828192-269c-4bc7-943b-273555227961",
"type": "machine",
"id": "4ecec95a-0493-4df0-bd1c-c97712561077",
"role": "id_user_admin"
}
],
"provisionSource": "AD",
"meta": {
"organizationID": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6"
}
}
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get a group",
"operationId": "Get a group",
"description": "Retrieve details for a group, by ID.\n\nOptionally, members can be retrieved with this request. The maximum number of members returned is 500.\n\n
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`",
"tags": [
"SCIM 2 Groups"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.",
"required": true,
"example": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"schema": {
"type": "string"
}
},
{
"name": "groupId",
"in": "path",
"description": "A unique identifier for the group.",
"required": true,
"example": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"schema": {
"type": "string"
}
},
{
"name": "excludedAttributes",
"in": "query",
"description": "Attributes to be excluded from the return.",
"example": "members",
"schema": {
"type": "string"
}
}
]
},
"put": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetGroupResponse"
},
"example": {
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group"
],
"id": "w48389cd-4cc3-4a80-8b6d-ecb5632ea117",
"displayName": "test_Wade_newName@webex.identity.com",
"externalId": "test_new",
"members": [
{
"value": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
"type": "user",
"example": "https://example.com/v2/Users/c5349664-9f3d-410b-8bd3-6c31f181f13d",
"display": "A user"
},
{
"value": "ffd2164c-b938-46dd-8b2f-def6c33b45d0",
"type": "group",
"example": "https://example.com/v2/Groups/ffd2164c-b938-46dd-8b2f-def6c33b45d0",
"display": "A nested group"
}
],
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group": {
"usage": "policy",
"inheritances": [
{
"type": "role",
"value": "id_full_admin",
"nested": false,
"scope": [
"user"
]
}
],
"owners": [
{
"value": "bb9e77e5-91c3-4006-87c7-c18d885174c7"
},
{
"value": "93e10e81-f836-434c-8e4c-8f496aeef8d5"
}
],
"managedBy": [
{
"orgId": "e82f0522-09b1-49fb-9fff-735fee313456",
"type": "user",
"id": "0f0c3024-73dc-4e1f-b4b0-f47e67c0399c",
"role": "location_full_admin"
},
{
"orgId": "cd828192-269c-4bc7-943b-273555227961",
"type": "machine",
"id": "4ecec95a-0493-4df0-bd1c-c97712561077",
"role": "id_user_admin"
}
],
"provisionSource": "AAD",
"meta": {
"organizationID": "bb9e77e5-91c3-4006-87c7-c18d885174c7"
}
},
"meta": {
"resourceType": "group",
"location": "https://identity.webex.com/identity/scim/bb9e77e5-91c3-4006-87c7-c18d885174c7/v2/Groups/w48389cd-4cc3-4a80-8b6d-ecb5632ea117",
"version": "W/\"73585827739\"",
"created": "2022-11-15T08:21:54.725Z",
"lastModified": "2022-11-15T08:21:54.725Z"
}
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Update a group with PUT",
"operationId": "Update a group with PUT",
"description": "Replace the contents of the Group.\n\nSpecify the group ID in the `groupId` parameter in the URI.\n\n
\n\n**Authorization**\n\nOAuth token returned by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n
\n\n**Usage**:\n\n1. The input JSON must conform to one of the following schemas:\n - `urn:ietf:params:scim:schemas:core:2.0:Group`\n - `urn:scim:schemas:extension:cisco:webexidentity:2.0:Group`\n\n1. Unrecognized schemas (ID/section) are ignored.\n\n1. Read-only attributes provided as input values are ignored.\n\n1. The group `id` is not changed.\n\n1. All attributes are cleaned up if a new value is not provided by the client.\n\n1. The values, `meta` and `created` are not changed.",
"tags": [
"SCIM 2 Groups"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.",
"required": true,
"example": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"schema": {
"type": "string"
}
},
{
"name": "groupId",
"in": "path",
"description": "A unique identifier for the group.",
"required": true,
"example": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group"
],
"displayName": "group1@example.com",
"externalId": "test",
"members": [
{
"value": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
"type": "user"
}
],
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group": {
"usage": "policy",
"inheritances": [
{
"type": "role",
"value": "id_full_admin",
"nested": false,
"scope": [
"user"
]
}
],
"owners": [
{
"value": "c5349664-9f3d-410b-8bd3-6c31f181f13d"
}
],
"managedBy": [
{
"orgId": "d1349664-9f3d-410b-8bd3-6c31f181f14e",
"type": "user",
"id": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
"role": "location_full_admin"
}
]
}
},
"schema": {
"$ref": "#/components/schemas/PutGroup"
}
}
}
}
},
"patch": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetGroupResponse"
},
"example": {
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group"
],
"id": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"displayName": "wade_test_ccbeca2c-5f25-4c3a-b03c-e3bbc5368405@webex.identity.com",
"externalId": "test",
"members": [
{
"value": "9836fa05-21f4-4fbc-8863-8eaf3dfbabe7",
"type": "user",
"example": "https://example.com/v2/Users/9836fa05-21f4-4fbc-8863-8eaf3dfbabe7",
"display": "A user"
},
{
"value": "ffd2164c-b938-46dd-8b2f-def6c33b45d0",
"type": "group",
"example": "https://example.com/v2/Groups/ffd2164c-b938-46dd-8b2f-def6c33b45d0",
"display": "A nested group"
}
],
"meta": {
"resourceType": "group",
"created": "2011-08-01T21:32:44.882Z",
"lastModified": "2011-08-01T21:32:44.882Z",
"version": "W/\"e180ee84f0671b1\"",
"location": "https://example.com/v2/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a"
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group": {
"usage": "location",
"inheritances": [
{
"type": "role",
"value": "id_full_admin",
"nested": false,
"scope": [
"user"
]
}
],
"owners": [
{
"value": "bb9e77e5-91c3-4006-87c7-c18d885174c7"
},
{
"value": "93e10e81-f836-434c-8e4c-8f496aeef8d5"
}
],
"managedBy": [
{
"orgId": "e82f0522-09b1-49fb-9fff-735fee313456",
"type": "user",
"id": "0f0c3024-73dc-4e1f-b4b0-f47e67c0399c",
"role": "location_full_admin"
},
{
"orgId": "cd828192-269c-4bc7-943b-273555227961",
"type": "machine",
"id": "4ecec95a-0493-4df0-bd1c-c97712561077",
"role": "id_user_admin"
}
],
"provisionSource": "AD",
"meta": {
"organizationID": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6"
}
}
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Update a group with PATCH",
"operationId": "Update a group with PATCH",
"description": "Update group attributes with PATCH.\n\nSpecify the group ID in the `groupId` parameter in the URI.\n\n
\n\n**Authorization**\n\nOAuth token returned by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n
\n\n**Usage**:\n\n1. The input JSON must conform to one of the following schemas:\n - `urn:ietf:params:scim:schemas:core:2.0:Group`\n - `urn:scim:schemas:extension:cisco:webexidentity:2.0:Group`\n\n1. Unrecognized schemas (ID/section) are ignored.\n\n1. Read-only attributes provided as input values are ignored.\n\n1. Each operation on an attribute must be compatible with the attribute's mutability.\n\n1. Each PATCH operation represents a single action to be applied to the\n same SCIM resource specified by the request URI. Operations are\n applied sequentially in the order they appear in the array. Each\n operation in the sequence is applied to the target resource; the\n resulting resource becomes the target of the next operation.\n Evaluation continues until all operations are successfully applied or\n until an error condition is encountered.\n\n
\n\n**Add operations**:\n\nThe `add` operation is used to add a new attribute value to an existing resource. The operation must contain a `value` member whose content specifies the value to be added. The value may be a quoted value, or it may be a JSON object containing the sub-attributes of the complex attribute specified in the operation's `path`. The result of the add operation depends upon the target location indicated by `path` references:\n\n
\n\n- If omitted, the target location is assumed to be the resource itself. The `value` parameter contains a set of attributes to be added to the resource.\n\n- If the target location does not exist, the attribute and value are added.\n\n- If the target location specifies a complex attribute, a set of sub-attributes shall be specified in the `value` parameter.\n\n- If the target location specifies a multi-valued attribute, a new value is added to the attribute.\n\n- If the target location specifies a single-valued attribute, the existing value is replaced.\n\n- If the target location specifies an attribute that does not exist (has no value), the attribute is added with the new value.\n\n- If the target location exists, the value is replaced.\n\n- If the target location already contains the value specified, no changes should be made to the resource.\n\n
\n\n**Replace operations**:\n\nThe `replace` operation replaces the value at the target location specified by the `path`. The operation performs the following functions, depending on the target location specified by `path`:\n\n
\n\n- If the `path` parameter is omitted, the target is assumed to be the resource itself. In this case, the `value` attribute shall contain a list of one or more attributes that are to be replaced.\n\n- If the target location is a single-value attribute, the value of the attribute is replaced.\n\n- If the target location is a multi-valued attribute and no filter is specified, the attribute and all values are replaced.\n\n- If the target location path specifies an attribute that does not exist, the service provider shall treat the operation as an \"add\".\n\n- If the target location specifies a complex attribute, a set of sub-attributes SHALL be specified in the `value` parameter, which replaces any existing values or adds where an attribute did not previously exist. Sub-attributes that are not specified in the `value` parameters are left unchanged.\n\n- If the target location is a multi-valued attribute and a value selection (\"valuePath\") filter is specified that matches one or more values of the multi-valued attribute, then all matching record values will be replaced.\n\n- If the target location is a complex multi-valued attribute with a value selection filter (\"valuePath\") and a specific sub-attribute (e.g., \"addresses[type eq \"work\"].streetAddress\"), the matching sub-attribute of all matching records is replaced.\n\n- If the target location is a multi-valued attribute for which a value selection filter (\"valuePath\") has been supplied and no record match was made, the service provider will indicate the failure by returning HTTP status code 400 and a `scimType` error code of `noTarget`.\n\n
\n\n**Remove operations**:\n\nThe `remove` operation removes the value at the target location specified by the required attribute `path`. The operation performs the following functions, depending on the target location specified by `path`:\n\n
\n\n- If `path` is unspecified, the operation fails with HTTP status code 400 and a \"scimType\" error code of \"noTarget\".\n\n- If the target location is a single-value attribute, the attribute and its associated value is removed, and the attribute will be considered unassigned.\n\n- If the target location is a multi-valued attribute and no filter is specified, the attribute and all values are removed, and the attribute SHALL be considered unassigned.\n\n- If the target location is a multi-valued attribute and a complex filter is specified comparing a `value`, the values matched by the filter are removed. If no other values remain after the removal of the selected values, the multi-valued attribute will be considered unassigned.\n\n- If the target location is a complex multi-valued attribute and a complex filter is specified based on the attribute`s sub-attributes, the matching records are removed. Sub-attributes whose values have been removed will be considered unassigned. If the complex multi-valued attribute has no remaining records, the attribute will be considered unassigned.",
"tags": [
"SCIM 2 Groups"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.",
"required": true,
"example": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"schema": {
"type": "string"
}
},
{
"name": "groupId",
"in": "path",
"description": "A unique identifier for the group.",
"required": true,
"example": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "add",
"path": "urn:scim:schemas:extension:cisco:webexidentity:2.0:Group.inheritances",
"value": [
{
"type": "role",
"value": "id_user_admin",
"nested": false,
"scope": [
"user"
]
}
]
}
]
},
"schema": {
"$ref": "#/components/schemas/PatchGroup"
}
}
}
}
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Delete a group",
"operationId": "Delete a group",
"description": "Remove a group from the system.\n\nSpecify the group ID in the `groupId` parameter in the URI.\n\n
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`",
"tags": [
"SCIM 2 Groups"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.",
"required": true,
"example": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"schema": {
"type": "string"
}
},
{
"name": "groupId",
"in": "path",
"description": "A unique identifier for the group.",
"required": true,
"example": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"schema": {
"type": "string"
}
}
]
}
},
"/identity/scim/{orgId}/v2/Groups/{groupId}/Members": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupMemberResponse"
},
"example": {
"schemas": [
"urn:scim:schemas:extension:cisco:webexidentity:2.0:GroupMembers"
],
"memberSize": 2,
"displayName": "group_name",
"itemsPerPage": 2,
"startIndex": 1,
"members": [
{
"value": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
"type": "user",
"display": "A user"
},
{
"value": "ffd2164c-b938-46dd-8b2f-def6c33b45d0",
"type": "group",
"display": "A nested group"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Group Members",
"operationId": "Get Group Members",
"description": "Returns the members of a group.\n\n- The default maximum number of members returned is 500.\n\n- Control parameters are available to page through the members and to control the size of the results.\n\n- Long result sets are split into [pages](/docs/basics#pagination).\n\n**Note**\nLocation groups are different from SCIM groups. You cannot search for identities in a location via groups.\n\n
\n\n**Authorization**\n\nOAuth token returned by the Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`",
"tags": [
"SCIM 2 Groups"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.",
"required": true,
"example": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"schema": {
"type": "string"
}
},
{
"name": "groupId",
"in": "path",
"description": "A unique identifier for the group.",
"required": true,
"example": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"schema": {
"type": "string"
}
},
{
"name": "startIndex",
"in": "query",
"description": "The index to start for group pagination.",
"example": 1,
"schema": {
"type": "number"
}
},
{
"name": "count",
"in": "query",
"description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.",
"example": 100,
"schema": {
"type": "number"
}
},
{
"name": "memberType",
"in": "query",
"description": "Filter the members by member type. Sample data: `user`, `machine`, `group`.",
"example": "user",
"schema": {
"type": "string"
}
}
]
}
},
"/Schemas/SCIM2/Group": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetGroupSchemaResponse"
},
"example": {
"urn:ietf:params:scim:schemas:core:2.0:Group": {
"id": "urn:ietf:params:scim:schemas:core:2.0:Group",
"name": "Group",
"description": "Group",
"attributes": [
{
"name": "id",
"type": "String",
"multiValued": false,
"description": "A unique identifier of this `Group` resource defined by the service provider.",
"required": false,
"caseExact": true,
"mutability": "ReadOnly",
"returned": "Default",
"uniqueness": "Global"
},
{
"name": "displayName",
"type": "String",
"multiValued": false,
"description": "A human-readable name for the `Group`. REQUIRED.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
},
{
"name": "externalId",
"type": "String",
"multiValued": false,
"description": "An identifier for the resource as defined by the provision client.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 256
},
{
"name": "members",
"type": "String",
"multiValued": true,
"description": "A list of roles for the user that collectively represent who the user is.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "Reference",
"referenceTypes": [
"external"
],
"multiValued": false,
"description": "The identifier of the member of this `Group`.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "type",
"type": "String",
"multiValued": false,
"description": "A label indicating the type of resource, e.g., 'Group', 'Machine', or 'Group'.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"canonicalValues": [
"Group",
"User",
"Machine"
],
"uniqueness": "None"
},
{
"name": "display",
"type": "String",
"multiValued": false,
"description": "A human-readable name, primarily used for display purposes.",
"required": false,
"caseExact": false,
"mutability": "ReadOnly",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "$ref",
"type": "Reference",
"referenceTypes": [
"User",
"Group",
"Machine"
],
"multiValued": false,
"description": "The URI corresponding to a SCIM resource that is a member of this `Group`.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 500
}
]
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group": {
"id": "urn:scim:schemas:extension:cisco:webexidentity:2.0:Group",
"name": "Cisco Group",
"description": "Cisco Group",
"attributes": [
{
"name": "usage",
"type": "String",
"multiValued": false,
"description": "The identifier of this `Group`.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"location",
"distribution",
"policy"
],
"uniqueness": "None"
},
{
"name": "provisionSource",
"type": "String",
"multiValued": false,
"description": "The type of the account provision source.",
"required": false,
"caseExact": false,
"mutability": "ReadOnly",
"returned": "Default",
"canonicalValues": [
"SCIM",
"AD",
"AAD",
"BROADWORKS",
"OKTA"
],
"uniqueness": "None"
},
{
"name": "owners",
"type": "String",
"multiValued": true,
"description": "The owners of this group.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of owners.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "display",
"type": "String",
"multiValued": false,
"description": "A human-readable name, primarily used for display purposes.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "primary",
"type": "Boolean",
"multiValued": false,
"description": "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' must appear no more than once.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 30
},
{
"name": "managedBy",
"type": "String",
"multiValued": true,
"description": "The resources that have delegated roles on this `Group`.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "The organization identifier of the resource.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"uniqueness": "None",
"length": 64
},
{
"name": "type",
"type": "String",
"multiValued": false,
"description": "The resource type.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"canonicalValues": [
"Group",
"User",
"Machine"
],
"uniqueness": "None"
},
{
"name": "id",
"type": "String",
"multiValued": false,
"description": "The identifier of the resource.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "role",
"type": "String",
"multiValued": false,
"description": "The delegated role.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
}
],
"size": 30
},
{
"name": "inheritances",
"type": "String",
"multiValued": true,
"description": "Inheritance supported by this group.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "type",
"type": "String",
"multiValued": false,
"description": "The resource type.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"canonicalValues": [
"role"
],
"uniqueness": "None"
},
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"canonicalValues": [
"id_user_admin",
"id_readonly_admin",
"id_device_admin",
"id_full_admin"
],
"uniqueness": "None"
},
{
"name": "nested",
"type": "String",
"multiValued": false,
"description": "The boolean value if field is nested.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "scope",
"type": "String",
"multiValued": false,
"description": "The scope.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 10
},
{
"name": "memberFilter",
"type": "String",
"multiValued": true,
"description": "The memberFilter for the `Group`.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of memberFilter.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "display",
"type": "String",
"multiValued": false,
"description": "A human-readable name, primarily used for display purposes.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "type",
"type": "String",
"multiValued": false,
"description": "A label indicating the attribute's function.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"user"
],
"uniqueness": "None"
},
{
"name": "primary",
"type": "Boolean",
"multiValued": false,
"description": "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' must appear no more than once.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 1
},
{
"name": "groupType",
"type": "String",
"multiValued": false,
"description": "The type of the `Group`.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"unique_flat_static",
"dynamic",
"flat_static",
"nested_static"
],
"uniqueness": "None"
}
]
}
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Group Schema",
"operationId": "Get Group Schema",
"description": "This API allows the service client to get all the `Group` schemas information from CI.\n\n**Authorization:**\n\nOAuth token rendered by Identity Broker.\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:organizations_rw`\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`",
"tags": [
"SCIM 2 Schemas"
],
"parameters": []
}
},
"/Schemas/SCIM2/User": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetUserSchemaResponse"
},
"example": {
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User": {
"id": "urn:scim:schemas:extension:cisco:webexidentity:2.0:User",
"name": "EnterpriseUser",
"description": "Enterprise User",
"attributes": [
{
"name": "accountStatus",
"type": "String",
"multiValued": true,
"description": "Account status of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"compliance-transient",
"pending-transient",
"marked_deleted",
"transient",
"fraud-transient",
"fraud",
"pending",
"active",
"disabled",
"suspended"
],
"uniqueness": "None"
},
{
"name": "authProvider",
"type": "String",
"multiValued": false,
"description": "Authentication provider for the user. Base on organization configuration",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"facebook",
"O365",
"google",
"cco"
],
"uniqueness": "None"
},
{
"name": "teamsClusterId",
"type": "String",
"multiValued": false,
"description": "teamsClusterId of the organization user belongs to.",
"required": false,
"caseExact": false,
"mutability": "ReadOnly",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "isTeamsOnJabberEnabled",
"type": "Boolean",
"multiValued": false,
"description": "Whether user is enabled teams in Jabber.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "isUCCallOnJabberEnabled",
"type": "Boolean",
"multiValued": false,
"description": "Whether user is enabled On UC Call in Jabber.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "mfaEnabled",
"type": "Boolean",
"multiValued": false,
"description": "Whether user is enabled for MFA.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "macAddresses",
"type": "String",
"multiValued": true,
"description": "macAddresses assigned to this user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 50
},
{
"name": "licenseID",
"type": "String",
"multiValued": true,
"description": "licenseIDs assigned to this user. Webex Identity does not interpret the format or semantics of the value.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 1000
},
{
"name": "userSettings",
"type": "String",
"multiValued": true,
"description": "Settings value for the user. Webex Identity does not interpret the format or semantics of the value.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 1000
},
{
"name": "userPreferences",
"type": "String",
"multiValued": true,
"description": "User preference. Webex Identity does not interpret the format or semantics of the value.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 1000
},
{
"name": "sipAddresses",
"type": "Complex",
"multiValued": true,
"description": "SipAddress values for the User.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of sipAddresses.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "display",
"type": "String",
"multiValued": false,
"description": "A human-readable name, primarily used for display purposes.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "type",
"type": "String",
"multiValued": false,
"description": "A label indicating the attribute's function.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"enterprise",
"cloud-calling",
"personal-room"
],
"uniqueness": "None"
},
{
"name": "primary",
"type": "Boolean",
"multiValued": false,
"description": "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 2000
},
{
"name": "trainSiteNames",
"type": "String",
"multiValued": true,
"description": "List of CI-enabled sites the user belongs to.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 2000
},
{
"name": "managedSites",
"type": "Complex",
"multiValued": true,
"description": "Used to identify that the user is site admin of a site.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "siteName",
"type": "String",
"multiValued": false,
"description": "Site name",
"required": true,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
},
{
"name": "role",
"type": "String",
"multiValued": false,
"description": "Role in the site for the user.",
"required": true,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
}
],
"size": 2000
},
{
"name": "linkedTrainSiteNames",
"type": "String",
"multiValued": true,
"description": "List of none CI-enabled WebEx sites that the user is linked to through account linking process.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 2000
},
{
"name": "primaryLinkedTrainSiteName",
"type": "String",
"multiValued": false,
"description": "If set, Webex Identity will send user to the train site to login. Value is the name of the train site.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 128
},
{
"name": "toBeConverted",
"type": "String",
"multiValued": false,
"description": "To be converted value.",
"required": false,
"caseExact": false,
"mutability": "ReadOnly",
"returned": "Default",
"uniqueness": "None",
"length": 254
},
{
"name": "managedOrgs",
"type": "Complex",
"multiValued": true,
"description": "Organizations that the user can manage.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "Identity of the organization",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
},
{
"name": "role",
"type": "String",
"multiValued": false,
"description": "Role in the target organization for the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
}
],
"size": 2000
},
{
"name": "managedGroups",
"type": "Complex",
"multiValued": true,
"description": "Organizations that the user can manage.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "Identity of the organization",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
},
{
"name": "groupId",
"type": "String",
"multiValued": false,
"description": "Identity of the group",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
},
{
"name": "role",
"type": "String",
"multiValued": false,
"description": "Role in the target group for the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
}
],
"size": 2000
},
{
"name": "extLinkedAccts",
"type": "Complex",
"multiValued": true,
"description": "External linked account for the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "providerID",
"type": "String",
"multiValued": false,
"description": "Identity for the external linked account provider.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
},
{
"name": "accountGUID",
"type": "String",
"multiValued": false,
"description": "Identifier of the external account, this should be set to a unique identifier from the external source, CI does not enforce format or semantics of this attribute (as long as it is a string).",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
},
{
"name": "status",
"type": "String",
"multiValued": false,
"description": "External linked account status.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
}
],
"size": 2000
},
{
"name": "loginIds",
"type": "Complex",
"multiValued": true,
"description": "LoginIds for a partner-upn user",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "UserName of the user",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
},
{
"name": "format",
"type": "String",
"multiValued": false,
"description": "Format of the user",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
},
{
"name": "type",
"type": "String",
"multiValued": false,
"description": "Type of the user",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 256
},
{
"name": "status",
"type": "String",
"multiValued": false,
"description": "Status of the user",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
},
{
"name": "lastValidated",
"type": "String",
"multiValued": false,
"description": "TimeStamp for the entry",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
}
],
"size": 2000
},
{
"name": "avatarSyncEnabled",
"type": "Boolean",
"multiValued": false,
"description": "Whether user is enabled for avatar Sync.",
"required": false,
"caseExact": false,
"mutability": "ReadOnly",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "provisionSource",
"type": "String",
"multiValued": false,
"description": "The type of the account provision source.",
"required": false,
"caseExact": false,
"mutability": "ReadOnly",
"returned": "Default",
"canonicalValues": [
"SCIM",
"AD",
"AAD",
"BROADWORKS",
"OKTA"
],
"uniqueness": "None"
},
{
"name": "pronouns",
"type": "Complex",
"multiValued": false,
"description": "The pronouns of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of pronouns.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "visibility",
"type": "String",
"multiValued": false,
"description": "The visibility of pronouns. Can be Hidden, Internal, Everyone or global.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"Everyone",
"Internal",
"Hidden",
"Global"
],
"uniqueness": "None"
}
]
},
{
"name": "userNameType",
"type": "String",
"multiValued": false,
"description": "Format of username. Possible Values : Email, PartnerUPN, Phone",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"phone",
"partner-upn",
"email"
],
"uniqueness": "None"
},
{
"name": "extensionAttribute1",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute2",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute3",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute4",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute5",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute6",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute7",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute8",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute9",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute10",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute11",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute12",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute13",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute14",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "extensionAttribute15",
"type": "String",
"multiValued": true,
"description": "The extensionAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"size": 100
},
{
"name": "externalAttribute1",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "externalAttribute2",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "externalAttribute3",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "externalAttribute4",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "externalAttribute5",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "externalAttribute6",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "externalAttribute7",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "externalAttribute8",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "externalAttribute9",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "externalAttribute10",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "externalAttribute11",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "externalAttribute12",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "externalAttribute13",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "externalAttribute14",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "externalAttribute15",
"type": "Complex",
"multiValued": true,
"description": "The externalAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The source of external attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "crossOrgAttribute1",
"type": "Complex",
"multiValued": true,
"description": "The crossOrgAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "The orgId of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "crossOrgAttribute2",
"type": "Complex",
"multiValued": true,
"description": "The crossOrgAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "The orgId of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "crossOrgAttribute3",
"type": "Complex",
"multiValued": true,
"description": "The crossOrgAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "The orgId of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "crossOrgAttribute4",
"type": "Complex",
"multiValued": true,
"description": "The crossOrgAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "The orgId of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "crossOrgAttribute5",
"type": "Complex",
"multiValued": true,
"description": "The crossOrgAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "The orgId of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "crossOrgAttribute6",
"type": "Complex",
"multiValued": true,
"description": "The crossOrgAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "The orgId of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "crossOrgAttribute7",
"type": "Complex",
"multiValued": true,
"description": "The crossOrgAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "The orgId of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "crossOrgAttribute8",
"type": "Complex",
"multiValued": true,
"description": "The crossOrgAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "The orgId of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "crossOrgAttribute9",
"type": "Complex",
"multiValued": true,
"description": "The crossOrgAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "The orgId of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "crossOrgAttribute10",
"type": "Complex",
"multiValued": true,
"description": "The crossOrgAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "The orgId of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "crossOrgAttribute11",
"type": "Complex",
"multiValued": true,
"description": "The crossOrgAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "The orgId of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "crossOrgAttribute12",
"type": "Complex",
"multiValued": true,
"description": "The crossOrgAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "The orgId of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "crossOrgAttribute13",
"type": "Complex",
"multiValued": true,
"description": "The crossOrgAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "The orgId of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "crossOrgAttribute14",
"type": "Complex",
"multiValued": true,
"description": "The crossOrgAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "The orgId of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "crossOrgAttribute15",
"type": "Complex",
"multiValued": true,
"description": "The crossOrgAttributes of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "orgId",
"type": "String",
"multiValued": false,
"description": "The orgId of cross org attribute.",
"required": false,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
}
]
},
"urn:ietf:params:scim:schemas:core:2.0:User": {
"id": "urn:ietf:params:scim:schemas:core:2.0:User",
"name": "User",
"description": "User account",
"attributes": [
{
"name": "id",
"type": "String",
"multiValued": false,
"description": "A unique identifier for a SCIM resource as defined by the service provider.",
"required": false,
"caseExact": true,
"mutability": "ReadOnly",
"returned": "Default",
"uniqueness": "Global"
},
{
"name": "userName",
"type": "String",
"multiValued": false,
"description": "Unique identifier for the User, typically used by the user to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the service provider's entire set of Users.",
"required": true,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 254
},
{
"name": "password",
"type": "String",
"multiValued": false,
"description": "The User's cleartext password.",
"required": false,
"caseExact": true,
"mutability": "WriteOnly",
"returned": "Never",
"uniqueness": "None",
"length": 256
},
{
"name": "active",
"type": "Boolean",
"multiValued": false,
"description": "A Boolean value indicating the User's administrative status.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "roles",
"type": "Complex",
"multiValued": true,
"description": "A list of roles for the User that collectively represent who the User is.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of roles.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "display",
"type": "String",
"multiValued": false,
"description": "A human-readable name, primarily used for display purposes.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "type",
"type": "String",
"multiValued": false,
"description": "A label indicating the attribute's function.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"ciRole",
"serviceRole",
"globalRole"
],
"uniqueness": "None"
},
{
"name": "primary",
"type": "Boolean",
"multiValued": false,
"description": "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "entitlements",
"type": "Complex",
"multiValued": true,
"description": "A list of entitlements for the User that represent a thing the User has.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of entitlements.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "display",
"type": "String",
"multiValued": false,
"description": "A human-readable name, primarily used for display purposes.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "primary",
"type": "Boolean",
"multiValued": false,
"description": "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 100
},
{
"name": "name",
"type": "Complex",
"multiValued": false,
"description": "The components of the user's real name.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "familyName",
"type": "String",
"multiValued": false,
"description": "The family name of the User, or last name in most Western languages (e.g., 'Jensen' given the full name 'Ms. Barbara J Jensen, III').",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 256
},
{
"name": "givenName",
"type": "String",
"multiValued": false,
"description": "The given name of the User, or first name in most Western languages (e.g., 'Barbara' given the full name 'Ms. Barbara J Jensen, III').",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 256
},
{
"name": "middleName",
"type": "String",
"multiValued": false,
"description": "The middle name(s) of the User (e.g., 'Jane' given the full name 'Ms. Barbara J Jensen, III').",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 256
},
{
"name": "honorificPrefix",
"type": "String",
"multiValued": false,
"description": "The honorific prefix(es) of the User, or title in most Western languages (e.g., 'Ms.' given the full name 'Ms. Barbara J Jensen, III').",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 256
},
{
"name": "honorificSuffix",
"type": "String",
"multiValued": false,
"description": "The honorific suffix(es) of the User, or suffix in most Western languages (e.g., 'III' given the full name 'Ms. Barbara J Jensen, III').",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 256
},
{
"name": "formatted",
"type": "String",
"multiValued": false,
"description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display (e.g., 'Ms. Barbara Jane Jensen, III').",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
}
]
},
{
"name": "displayName",
"type": "String",
"multiValued": false,
"description": "The name of the User, suitable for display to end-users. The name SHOULD be the full name of the User being described, if known.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
},
{
"name": "nickName",
"type": "String",
"multiValued": false,
"description": "The casual way to address the user in real life, e.g., 'Bob' or 'Bobby' instead of 'Robert'. This attribute SHOULD NOT be used to represent a User's username (e.g., 'bjensen' or 'mpepperidge').",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 256
},
{
"name": "emails",
"type": "Complex",
"multiValued": true,
"description": "Email addresses for the user. The value SHOULD be canonicalized by the service provider, e.g., 'bjensen@example.com' instead of 'bjensen@EXAMPLE.COM'. Canonical type values of 'work', 'home', and 'other'.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of emails.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "display",
"type": "String",
"multiValued": false,
"description": "A human-readable name, primarily used for display purposes.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "type",
"type": "String",
"multiValued": false,
"description": "A label indicating the attribute's function.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"other",
"work",
"room",
"home"
],
"uniqueness": "None"
},
{
"name": "primary",
"type": "Boolean",
"multiValued": false,
"description": "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 10
},
{
"name": "userType",
"type": "String",
"multiValued": false,
"description": "Type of the user.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"user",
"external_calling",
"room",
"calling_service"
],
"uniqueness": "None"
},
{
"name": "profileUrl",
"type": "Reference",
"referenceTypes": [
"external"
],
"multiValued": false,
"description": "A fully qualified URL pointing to a page representing the User's online profile.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 1000
},
{
"name": "title",
"type": "String",
"multiValued": false,
"description": "The user's title, such as \"Vice President.\"",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
},
{
"name": "preferredLanguage",
"type": "String",
"multiValued": false,
"description": "Indicates the User's preferred written or spoken language. Generally used for selecting a localized user interface; e.g., 'en_US' specifies the language English and country US.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "locale",
"type": "String",
"multiValued": false,
"description": "Used to indicate the User's default location for purposes of localizing items such as currency, date time format, or numerical representations.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "timezone",
"type": "String",
"multiValued": false,
"description": "The User's time zone in the 'Olson' time zone database format, e.g., 'America/Los_Angeles'.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "externalId",
"type": "String",
"multiValued": false,
"description": "External Identity.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 256
},
{
"name": "phoneNumbers",
"type": "Complex",
"multiValued": true,
"description": "Phone numbers for the User.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of phoneNumbers.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "display",
"type": "String",
"multiValued": false,
"description": "A human-readable name, primarily used for display purposes.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "type",
"type": "String",
"multiValued": false,
"description": "A label indicating the attribute's function.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"alternate1",
"work",
"mobile",
"work_extension",
"fax",
"alternate2"
],
"uniqueness": "None"
},
{
"name": "primary",
"type": "Boolean",
"multiValued": false,
"description": "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 50
},
{
"name": "ims",
"type": "Complex",
"multiValued": true,
"description": "Instant messaging addresses for the User.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of ims.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "display",
"type": "String",
"multiValued": false,
"description": "A human-readable name, primarily used for display purposes.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "type",
"type": "String",
"multiValued": false,
"description": "A label indicating the attribute's function.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"qq",
"aim",
"cucm-jid",
"webex-squared-jid",
"msn",
"xmpp",
"skype",
"gtalk",
"icq",
"yahoo",
"microsoft-sip-uri",
"webex-messenger-jid",
"xmpp-fed-jid"
],
"uniqueness": "None"
},
{
"name": "primary",
"type": "Boolean",
"multiValued": false,
"description": "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 50
},
{
"name": "photos",
"type": "Complex",
"multiValued": true,
"description": "URLs of photos of the User.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of photos.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "display",
"type": "String",
"multiValued": false,
"description": "A human-readable name, primarily used for display purposes.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "type",
"type": "String",
"multiValued": false,
"description": "A label indicating the attribute's function.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"thumbnail",
"resizable",
"photo"
],
"uniqueness": "None"
},
{
"name": "primary",
"type": "Boolean",
"multiValued": false,
"description": "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 50
},
{
"name": "x509Certificates",
"type": "Complex",
"multiValued": true,
"description": "A list of certificates issued to the User.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The value of x509Certificates.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "display",
"type": "String",
"multiValued": false,
"description": "A human-readable name, primarily used for display purposes.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "primary",
"type": "Boolean",
"multiValued": false,
"description": "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 30
},
{
"name": "addresses",
"type": "Complex",
"multiValued": true,
"description": "A physical mailing address for this User.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "type",
"type": "String",
"multiValued": false,
"description": "A label indicating the attribute's function.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"canonicalValues": [
"other",
"work",
"home"
],
"uniqueness": "None"
},
{
"name": "streetAddress",
"type": "String",
"multiValued": false,
"description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. This attribute MAY contain newlines.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
},
{
"name": "locality",
"type": "String",
"multiValued": false,
"description": "The city or locality component.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 128
},
{
"name": "region",
"type": "String",
"multiValued": false,
"description": "The state or region component.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
},
{
"name": "postalCode",
"type": "String",
"multiValued": false,
"description": "The zip code or postal code component.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 64
},
{
"name": "country",
"type": "String",
"multiValued": false,
"description": "The country name component.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 10
},
{
"name": "groups",
"type": "Complex",
"multiValued": true,
"description": "A list of groups to which the user belongs.",
"required": false,
"caseExact": false,
"mutability": "ReadOnly",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "Reference",
"referenceTypes": [
"external"
],
"multiValued": false,
"description": "The identifier of the User's group.",
"required": false,
"caseExact": false,
"mutability": "ReadOnly",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "display",
"type": "String",
"multiValued": false,
"description": "A human-readable name, primarily used for display purposes.",
"required": false,
"caseExact": false,
"mutability": "ReadOnly",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "$ref",
"type": "Reference",
"referenceTypes": [
"Group"
],
"multiValued": false,
"description": "The URI of the corresponding 'Group' resource to which the user belongs.",
"required": false,
"caseExact": false,
"mutability": "ReadOnly",
"returned": "Default",
"uniqueness": "None"
}
]
},
{
"name": "inheritances",
"type": "String",
"multiValued": true,
"description": "A list of inheritances for the User.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "type",
"type": "String",
"multiValued": false,
"description": "The inheritance type.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The inheritance value.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "source",
"type": "String",
"multiValued": false,
"description": "The inheritance source.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"uniqueness": "None"
}
]
}
]
},
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"id": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"name": "EnterpriseUser",
"description": "Enterprise User",
"attributes": [
{
"name": "employeeNumber",
"type": "String",
"multiValued": false,
"description": "Numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 256
},
{
"name": "costCenter",
"type": "String",
"multiValued": false,
"description": "Identifies the name of a cost center.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 256
},
{
"name": "organization",
"type": "String",
"multiValued": false,
"description": "Identifies the name of an organization.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
},
{
"name": "division",
"type": "String",
"multiValued": false,
"description": "Identifies the name of a division.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
},
{
"name": "department",
"type": "String",
"multiValued": false,
"description": "Identifies the name of a department.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
},
{
"name": "manager",
"type": "Complex",
"multiValued": false,
"description": "The User's manager.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "String",
"multiValued": false,
"description": "The identifier of the user's manager.",
"required": true,
"caseExact": true,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
},
{
"name": "displayName",
"type": "String",
"multiValued": false,
"description": "The displayName of the User's manager.",
"required": false,
"caseExact": false,
"mutability": "ReadOnly",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "$ref",
"type": "Reference",
"referenceTypes": [
"User"
],
"multiValued": false,
"description": "The displayName of the User's manager.",
"required": false,
"caseExact": false,
"mutability": "ReadOnly",
"returned": "Default",
"uniqueness": "None"
}
]
}
]
}
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get User Schema",
"operationId": "Get User Schema",
"description": "This API allows the service client to get all the `User` schemas information from CI.\n\n**Authorization:**\n\nOAuth token rendered by Identity Broker.\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:organizations_rw`\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`",
"tags": [
"SCIM 2 Schemas"
],
"parameters": []
}
},
"/Schemas/SCIM2/{schemaId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetGroupResponseBySchemaId"
},
"example": {
"id": "urn:ietf:params:scim:schemas:core:2.0:Group",
"name": "Group",
"description": "Group",
"attributes": [
{
"name": "id",
"type": "String",
"multiValued": false,
"description": "A unique identifier of this `Group` resource defined by the service provider.",
"required": false,
"caseExact": true,
"mutability": "ReadOnly",
"returned": "Default",
"uniqueness": "Global"
},
{
"name": "displayName",
"type": "String",
"multiValued": false,
"description": "A human-readable name for the `Group`. REQUIRED.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 512
},
{
"name": "externalId",
"type": "String",
"multiValued": false,
"description": "An identifier for the resource as defined by the provision client.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"length": 256
},
{
"name": "members",
"type": "String",
"multiValued": true,
"description": "A list of roles for the user that collectively represent who the user is.",
"required": false,
"caseExact": false,
"mutability": "ReadWrite",
"returned": "Default",
"uniqueness": "None",
"subAttributes": [
{
"name": "value",
"type": "Reference",
"referenceTypes": [
"external"
],
"multiValued": false,
"description": "The identifier of the member of this `Group`.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "type",
"type": "String",
"multiValued": false,
"description": "A label indicating the type of resource, e.g., 'Group', 'Machine', or 'Group'.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"canonicalValues": [
"Group",
"User",
"Machine"
],
"uniqueness": "None"
},
{
"name": "display",
"type": "String",
"multiValued": false,
"description": "A human-readable name, primarily used for display purposes.",
"required": false,
"caseExact": false,
"mutability": "ReadOnly",
"returned": "Default",
"uniqueness": "None"
},
{
"name": "$ref",
"type": "Reference",
"referenceTypes": [
"User",
"Group",
"Machine"
],
"multiValued": false,
"description": "The URI corresponding to a SCIM resource that is a member of this `Group`.",
"required": false,
"caseExact": false,
"mutability": "Immutable",
"returned": "Default",
"uniqueness": "None"
}
],
"size": 500
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Schema using Group Schema ID",
"operationId": "Get Schema using Group Schema ID",
"description": "This API allows the service client to get the Group/User Schema using `Schema Id` from CI.\n\nExample:\n\n- `urn:ietf:params:scim:schemas:core:2.0:Group` is one of the `Group Schema Id`. Using this particular ID, we can fetch all information related to it.\n\n- `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` is one of the `User Schema Id`. Using this particular ID, we can fetch all information related to it.\n\n**Authorization:**\n\nOAuth token rendered by Identity Broker.\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:organizations_rw`\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`",
"tags": [
"SCIM 2 Schemas"
],
"parameters": [
{
"name": "schemaId",
"in": "path",
"description": "The Schema Id of Group/User Schema",
"required": true,
"example": "urn:ietf:params:scim:schemas:core:2.0:Group",
"schema": {
"type": "string"
}
}
]
}
},
"/identity/scim/{orgId}/v2/Users": {
"post": {
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetUserResponse"
},
"example": {
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"id": "3426a8e3-d414-4bf0-a493-4f6787632a13",
"userName": "user1@example.com",
"active": true,
"roles": [
{
"value": "id_full_admin",
"type": "cirole",
"display": "Full administrator"
}
],
"name": {
"familyName": "Joestar",
"givenName": "Jonathan",
"middleName": "Jane",
"honorificPrefix": "Mr.",
"honorificSuffix": "III"
},
"displayName": "Mr. Jonathan Jane Joestar, III",
"nickName": "JoJo",
"emails": [
{
"value": "user1@example.home.com",
"type": "home",
"display": "home email description"
},
{
"value": "user1@example.com",
"type": "work",
"primary": true
}
],
"userType": "user",
"profileUrl": "https://jojowiki.com/Jonathan_Joestar",
"title": "Sales manager",
"preferredLanguage": "en_US",
"locale": "en_US",
"externalId": "externalIdValue",
"timezone": "America/Los_Angeles",
"phoneNumbers": [
{
"value": "400 123 1234",
"type": "work",
"primary": true,
"display": "work phone number"
}
],
"photos": [
{
"value": "https://photos.example.com/profilephoto/72930000000Ccne/F",
"type": "photo",
"primary": true,
"display": "photo description"
}
],
"addresses": [
{
"type": "work",
"streetAddress": "100 Universal City Plaza",
"locality": "Hollywood",
"region": "CA",
"postalCode": "91608",
"country": "US"
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "518-8888-888",
"costCenter": "costCenter 123",
"organization": "Cisco webexidentity",
"division": "division 456",
"department": "department 789",
"manager": {
"value": "b5717a4a-0169-43b2-ac3c-db20ba4e72cd",
"displayName": "Identity Administrator",
"example": "https://integration.webexapis.com/identity/scim/0ae87ade-8c8a-4952-af08-318798958d0c/v2/Users/b5717a4a-0169-43b2-ac3c-db20ba4e72cd"
}
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User": {
"accountStatus": [
"active"
],
"sipAddresses": [
{
"value": "sipAddress value1",
"type": "enterprise",
"primary": true,
"display": "sipAddress1 description"
}
],
"managedOrgs": [
{
"orgId": "75fe2995-24f5-4831-8d2c-1c2f8255912e",
"role": "id_full_admin"
}
],
"managedGroups": [
{
"orgId": "75fe2995-24f5-4831-8d2c-1c2f8255912e",
"groupId": "d178e396-aa06-42cd-ab98-5124eb3b1926",
"role": "id_full_admin"
}
],
"externalAttribute1": [
{
"source": "Source.1_7ddf1f2c-2985-4c37-a450-d58bbc201750",
"value": "externalAttribute1_value"
}
],
"externalAttribute2": [
{
"source": "Source.2_7ddf1f2c-2985-4c37-a450-d58bbc201750",
"value": "externalAttribute2_value"
}
],
"extensionAttribute1": [
"extensionAttribute1_Item1",
"extensionAttribute1_Item2"
],
"extensionAttribute2": [
"extensionAttribute2_Item1",
"extensionAttribute2_Item2",
"extensionAttribute2_Item3"
],
"meta": {
"organizationId": "0ae87ade-8c8a-4952-af08-318798958d0c"
}
},
"meta": {
"resourceType": "User",
"location": "http://integration.webexapis.com/identity/scim/0ae87ade-8c8a-4952-af08-318798958d0c/v2/Users/3426a8e3-d414-4bf0-a493-4f6787632a13",
"version": "W/\"76678575420\"",
"created": "2023-01-11T17:38:31.605Z",
"lastModified": "2023-01-11T17:38:31.605Z"
}
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Create a user",
"operationId": "Create a user",
"description": "The SCIM 2 /Users API provides a programmatic way to manage users in Webex Identity using The Internet Engineering Task Force standard SCIM 2.0 standard as specified by [RFC 7643 SCIM 2.0 Core Schema ](https://datatracker.ietf.org/doc/html/rfc7643) and [RFC 7644 SCIM 2.0 Core Protocol](https://datatracker.ietf.org/doc/html/rfc7644). The WebEx SCIM 2.0 APIs allow clients supporting the SCIM 2.0 standard to manage users, and groups within Webex. Webex supports the following SCIM 2.0 Schemas:\n\n• urn:ietf:params:scim:schemas:core:2.0:User\n\n• urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\n\n• urn:scim:schemas:extension:cisco:webexidentity:2.0:User\n\n
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n
\n\n**Usage**:\n\n1. Input JSON must contain schema: \"urn:ietf:params:scim:schemas:core:2.0:User\".\n\n2. Support 3 schemas :\n - \"urn:ietf:params:scim:schemas:core:2.0:User\"\n - \"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\"\n - \"urn:scim:schemas:extension:cisco:webexidentity:2.0:User\"\n\n3. Unrecognized schemas (ID/section) are ignored.\n\n4. Read-only attributes provided as input values are ignored.\n\n The following roles cannot be assigned to a user:\n\n1. Location Admin\n\n2. Webex Site Admin",
"tags": [
"SCIM 2 Users"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Webex Identity assigned organization identifier for user's organization.",
"required": true,
"example": "0ae87ade-8c8a-4952-af08-318798958d0c",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User"
],
"userName": "user1@example.com",
"userType": "user",
"title": "Sales manager",
"active": true,
"preferredLanguage": "en_US",
"locale": "en_US",
"timezone": "America/Los_Angeles",
"profileUrl": "https://jojowiki.com/Jonathan_Joestar",
"externalId": "externalIdValue",
"displayName": "Mr. Jonathan Jane Joestar, III",
"nickName": "JoJo",
"name": {
"givenName": "Sarah",
"familyName": "Henderson",
"middleName": "Jane",
"honorificPrefix": "Mr.",
"honorificSuffix": "III"
},
"roles": [
{
"value": "id_full_admin",
"type": "cirole",
"display": "Full administrator"
}
],
"phoneNumbers": [
{
"value": "400 123 1234",
"type": "work",
"display": "work phone number",
"primary": true
}
],
"photos": [
{
"value": "https://photos.example.com/profilephoto/72930000000Ccne/F",
"type": "photo",
"display": "photo description",
"primary": true
}
],
"addresses": [
{
"type": "work",
"streetAddress": "100 Universal City Plaza",
"locality": "Hollywood",
"region": "CA",
"postalCode": "91608",
"country": "US"
}
],
"emails": [
{
"value": "user1@example.home.com",
"type": "home",
"display": "home email description",
"primary": false
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"costCenter": "costCenter 123",
"organization": "Cisco webexidentity",
"division": "division 456",
"department": "department 789",
"employeeNumber": "518-8888-888",
"manager": {
"value": "b5717a4a-0169-43b2-ac3c-db20ba4e72cd"
}
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User": {
"accountStatus": "active",
"sipAddresses": [
{
"value": "sipAddress value1",
"type": "enterprise",
"display": "sipAddress1 description",
"primary": true
}
],
"managedOrgs": [
{
"orgId": "75fe2995-24f5-4831-8d2c-1c2f8255912e",
"role": "id_full_admin"
}
],
"managedGroups": [
{
"orgId": "0ae87ade-8c8a-4952-af08-318798958d0c",
"groupId": "3936af3e-15ff-43d1-9ef5-66c569ef34f5",
"role": "location_admin"
}
],
"extensionAttribute*": [],
"externalAttribute*": [
{
"source": "Source.1_7ddf1f2c-2985-4c37-a450-d58bbc201750",
"value": "externalAttribute1_value"
}
]
}
},
"schema": {
"$ref": "#/components/schemas/PostUser"
}
}
}
}
},
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchUserResponse"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Search users",
"operationId": "Search users",
"description": "
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`\n\n
",
"tags": [
"SCIM 2 Users"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Webex Identity assigned organization identifier for user's organization.",
"required": true,
"example": "0ae87ade-8c8a-4952-af08-318798958d0c",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core** | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |",
"example": "userName%20Eq%20%22user1%40example.com%22%20or%20userName%20Eq%20%22user2%40example.com%22",
"schema": {
"type": "string"
}
},
{
"name": "attributes",
"in": "query",
"description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned",
"example": "urn:ietf:params:scim:schemas:core:2.0:User",
"schema": {
"type": "string"
}
},
{
"name": "excludedAttributes",
"in": "query",
"description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned",
"example": "nickName,userType",
"schema": {
"type": "string"
}
},
{
"name": "sortBy",
"in": "query",
"description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort.",
"example": "userName",
"schema": {
"type": "string"
}
},
{
"name": "sortOrder",
"in": "query",
"description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'.",
"example": "ascending",
"schema": {
"type": "string"
}
},
{
"name": "startIndex",
"in": "query",
"description": "An integer for the 1-based index of the first query result. The default is 1.",
"example": "1",
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "An integer for the maximum number of query results per page. The default is 100.",
"example": "10",
"schema": {
"type": "string"
}
},
{
"name": "returnGroups",
"in": "query",
"description": "Define whether the group information needs to be returned. The default is false.",
"example": "false",
"schema": {
"type": "string"
}
},
{
"name": "includeGroupDetails",
"in": "query",
"description": "Define whether the group information with details needs to be returned. The default is false.",
"example": "false",
"schema": {
"type": "string"
}
},
{
"name": "groupUsageTypes",
"in": "query",
"description": "Returns groups with details of the specified group type.",
"example": "``",
"schema": {
"type": "string"
}
}
]
}
},
"/identity/scim/{orgId}/v2/Users/{userId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetUserResponse"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get a user",
"operationId": "Get a user",
"description": "
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`\n\n
",
"tags": [
"SCIM 2 Users"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Webex Identity assigned organization identifier for user's organization.",
"required": true,
"example": "0ae87ade-8c8a-4952-af08-318798958d0c",
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "path",
"description": "Webex Identity assigned user identifier.",
"required": true,
"example": "3426a8e3-d414-4bf0-a493-4f6787632a13",
"schema": {
"type": "string"
}
}
]
},
"put": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetUserResponse"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Update a user with PUT",
"operationId": "Update a user with PUT",
"description": "
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n
\n\n**Usage**:\n\n1. Input JSON must contain schema: \"urn:ietf:params:scim:schemas:core:2.0:User\".\n\n2. Support 3 schemas :\n - \"urn:ietf:params:scim:schemas:core:2.0:User\"\n - \"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\"\n - \"urn:scim:schemas:extension:cisco:webexidentity:2.0:User\"\n\n3. Unrecognized schemas (ID/section) are ignored.\n\n4. Read-only attributes provided as input values are ignored.\n\n5. User `id` will not be changed.\n\n6. `meta`.`created` will not be changed.\n\n7. The PUT API replaces the contents of the user's data with the data in the request body. All attributes specified in the request body will replace all existing attributes for the `userId` specified in the URL. Should you wish to replace or change some attributes as opposed to all attributes please refer to the SCIM PATCH operation https://developer.webex.com/docs/api/v1/scim2-user/update-a-user-with-patch.",
"tags": [
"SCIM 2 Users"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Webex Identity assigned organization identifier for user's organization.",
"required": true,
"example": "0ae87ade-8c8a-4952-af08-318798958d0c",
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "path",
"description": "Webex Identity assigned user identifier.",
"required": true,
"example": "3426a8e3-d414-4bf0-a493-4f6787632a13",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User"
],
"userName": "user1Changed@example.com",
"userType": "user",
"title": "Sales manager",
"active": true,
"preferredLanguage": "en_US",
"locale": "en_US",
"timezone": "America/Los_Angeles",
"profileUrl": "https://jojowiki.com/Jonathan_Joestar",
"externalId": "externalIdNewValue",
"displayName": "Mr. Jonathan Jane Joestar, III",
"nickName": "JoJo",
"roles": [
{
"value": "id_full_admin",
"type": "cirole",
"display": "Full administrator"
}
],
"phoneNumbers": [
{
"value": "400 123 1234",
"type": "work",
"display": "work phone number",
"primary": true
}
],
"photos": [
{
"value": "https://photos.example.com/profilephoto/72930000000Ccne/F",
"type": "photo",
"display": "photo description",
"primary": true
}
],
"addresses": [
{
"type": "work",
"streetAddress": "100 Universal City Plaza",
"locality": "Hollywood",
"region": "CA",
"postalCode": "91608",
"country": "US"
}
],
"emails": [
{
"value": "user1@example.home.com",
"type": "home",
"display": "home email description",
"primary": false
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"costCenter": "costCenter 123",
"organization": "Cisco webexidentity",
"division": "division 456",
"department": "department 789",
"employeeNumber": "518-8888-888",
"manager": {
"value": "b5717a4a-0169-43b2-ac3c-db20ba4e72cd"
}
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User": {
"accountStatus": "active",
"sipAddresses": [
{
"value": "sipAddress value1",
"type": "enterprise",
"display": "sipAddress1 description",
"primary": true
}
],
"managedOrgs": [
{
"orgId": "75fe2995-24f5-4831-8d2c-1c2f8255912e",
"role": "id_full_admin"
}
],
"managedGroups": [
{
"orgId": "0ae87ade-8c8a-4952-af08-318798958d0c",
"groupId": "3936af3e-15ff-43d1-9ef5-66c569ef34f5",
"role": "location_admin"
}
],
"extensionAttribute*": [],
"externalAttribute*": [
{
"source": "Source.1_7ddf1f2c-2985-4c37-a450-d58bbc201750",
"value": "externalAttribute1_value"
}
]
}
},
"schema": {
"$ref": "#/components/schemas/PutUser"
}
}
}
}
},
"patch": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetUserResponse"
},
"example": {
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"id": "3426a8e3-d414-4bf0-a493-4f6787632a13",
"userName": "user1Changed@example.com",
"active": true,
"roles": [
{
"value": "id_full_admin",
"type": "cirole",
"display": "Full administrator"
}
],
"name": {
"familyName": "Joestar",
"givenName": "Jonathan",
"middleName": "Jane",
"honorificPrefix": "Mr.",
"honorificSuffix": "III"
},
"displayName": "new displayName value",
"nickName": "JoJo",
"emails": [
{
"value": "user1@example.home.com",
"type": "home",
"display": "home email description"
},
{
"value": "user1Changed@example.com",
"type": "work",
"primary": true
}
],
"userType": "user",
"profileUrl": "https://jojowiki.com/Jonathan_Joestar",
"title": "Sales manager",
"preferredLanguage": "en_US",
"locale": "en_US",
"externalId": "externalIdNewValue",
"timezone": "America/Los_Angeles",
"phoneNumbers": [
{
"value": "400 123 1234",
"type": "work",
"primary": true,
"display": "work phone number"
}
],
"photos": [
{
"value": "https://photos.example.com/profilephoto/72930000000Ccne/F",
"type": "photo",
"primary": true,
"display": "photo description"
}
],
"addresses": [
{
"type": "work",
"streetAddress": "100 Universal City Plaza",
"locality": "Hollywood",
"region": "CA",
"postalCode": "91608",
"country": "US"
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "518-8888-888",
"costCenter": "costCenter 123",
"organization": "Cisco webexidentity",
"division": "division 456",
"department": "department 789",
"manager": {
"value": "b5717a4a-0169-43b2-ac3c-db20ba4e72cd",
"displayName": "Identity Administrator",
"example": "https://integration.webexapis.com/identity/scim/0ae87ade-8c8a-4952-af08-318798958d0c/v2/Users/b5717a4a-0169-43b2-ac3c-db20ba4e72cd"
}
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User": {
"accountStatus": [
"active"
],
"sipAddresses": [
{
"value": "sipAddress value1",
"type": "enterprise",
"primary": true,
"display": "sipAddress1 description"
}
],
"managedOrgs": [
{
"orgId": "75fe2995-24f5-4831-8d2c-1c2f8255912e",
"role": "id_full_admin"
}
],
"managedGroups": [
{
"orgId": "75fe2995-24f5-4831-8d2c-1c2f8255912e",
"groupId": "d178e396-aa06-42cd-ab98-5124eb3b1926",
"role": "id_full_admin"
}
],
"externalAttribute1": [
{
"source": "Source.1_7ddf1f2c-2985-4c37-a450-d58bbc201750",
"value": "externalAttribute1_value"
}
],
"externalAttribute2": [
{
"source": "Source.2_7ddf1f2c-2985-4c37-a450-d58bbc201750",
"value": "externalAttribute2_value"
}
],
"extensionAttribute1": [
"extensionAttribute1_Item1",
"extensionAttribute1_Item2"
],
"extensionAttribute2": [
"extensionAttribute2_Item1",
"extensionAttribute2_Item2",
"extensionAttribute2_Item3"
],
"meta": {
"organizationId": "0ae87ade-8c8a-4952-af08-318798958d0c"
}
},
"meta": {
"resourceType": "User",
"location": "http://integration.webexapis.com/identity/scim/0ae87ade-8c8a-4952-af08-318798958d0c/v2/Users/3426a8e3-d414-4bf0-a493-4f6787632a13",
"version": "W/\"88678579986\"",
"created": "2023-01-11T17:38:31.605Z",
"lastModified": "2023-02-02T11:38:31.009Z"
}
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Update a user with PATCH",
"operationId": "Update a user with PATCH",
"description": "
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n
\n\n**Usage**:\n\n1. The PATCH API replaces individual attributes and roles of the user's data in the request body.\n The PATCH API supports `add`, `remove`, and `replace` operations on any individual\n attribute or role allowing only specific attributes of the user's object to be modified.\n\n2. Each operation against an attribute must be compatible with the attribute's mutability.\n\n3. Each PATCH operation represents a single action to be applied to the\n same SCIM resource specified by the request URI. Operations are\n applied sequentially in the order they appear in the array. Each\n operation in the sequence is applied to the target resource; the\n resulting resource becomes the target of the next operation.\n Evaluation continues until all operations are successfully applied or\n until an error condition is encountered.\n\n
\n\n**Add operations**:\n\nThe `add` operation adds a new attribute value to an existing resource.\nThe operation must contain a `value` member whose content specifies the value to be added.\nThe value may be a quoted value, or it may be a JSON object containing the sub-attributes of the complex attribute specified in the operation's `path`.\nThe result of the add operation depends upon the target `path` reference locations:\n\n
\n\n- If omitted, the target location is assumed to be the resource itself. The `value` parameter contains a set of attributes to be added to the resource.\n\n- If the target location does not exist, the attribute and value are added.\n\n- If the target location specifies a complex attribute, a set of sub-attributes shall be specified in the `value` parameter.\n\n- If the target location specifies a multi-valued attribute, a new value is added to the attribute.\n\n- If the target location specifies a single-valued attribute, the existing value is replaced.\n\n- If the target location specifies an attribute that does not exist (has no value), the attribute is added with the new value.\n\n- If the target location exists, the value is replaced.\n\n- If the target location already contains the value specified, no changes should be made to the resource.\n\n
\n\n**Replace operations**:\n\nThe `replace` operation replaces the value at the target location specified by the `path`.\nThe operation performs the following functions, depending on the target location specified by `path`:\n\n
\n\n- If the `path` parameter is omitted, the target is assumed to be the resource itself. In this case, the `value` attribute shall contain a list of one or more attributes to be replaced.\n\n- If the target location is a single-value attribute, the value of the attribute is replaced.\n\n- If the target location is a multi-valued attribute and no filter is specified, the attribute and all values are replaced.\n\n- If the target location path specifies an attribute that does not exist, the service provider shall treat the operation as an \"add\".\n\n- If the target location specifies a complex attribute, a set of sub-attributes SHALL be specified in the `value` parameter, which replaces any existing values or adds where an attribute did not previously exist. Sub-attributes not specified in the `value` parameters are left unchanged.\n\n- If the target location is a multi-valued attribute and a value selection (\"valuePath\") filter is specified that matches one or more values of the multi-valued attribute, then all matching record values will be replaced.\n\n- If the target location is a complex multi-valued attribute with a value selection filter (\"valuePath\") and a specific sub-attribute (e.g., \"addresses[type eq \"work\"].streetAddress\"), the matching sub-attribute of all matching records is replaced.\n\n- If the target location is a multi-valued attribute for which a value selection filter (\"valuePath\") has been supplied and no record match was made, the service provider will return failure as HTTP status code 400 and a `scimType` error code of \"noTarget\".\n\n
\n\n**Remove operations**:\n\nThe `remove` operation removes the value at the target location specified by the required attribute `path`. The operation performs the following functions, depending on the target location specified by `path`:\n\n
\n\n- If `path` is unspecified, the operation fails with HTTP status code 400 and a \"scimType\" error code of \"noTarget\".\n\n- If the target location is a single-value attribute, the attribute and its associated value is removed, and the attribute will be considered unassigned.\n\n- If the target location is a multi-valued attribute and no filter is specified, the attribute and all values are removed, and the attribute SHALL be considered unassigned.\n\n- If the target location is a multi-valued attribute and a complex filter is specified comparing a `value`, the values matched by the filter are removed. If no other values remain after the removal of the selected values, the multi-valued attribute will be considered unassigned.\n\n- If the target location is a complex multi-valued attribute and a complex filter is specified based on the attribute's sub-attributes, the matching records are removed. Sub-attributes whose values have been removed will be considered unassigned. If the complex multi-valued attribute has no remaining records, the attribute will be considered unassigned.\n\n The following roles cannot be assigned to a user:\n\n1. Location Admin\n\n2. Webex Site Admin",
"tags": [
"SCIM 2 Users"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Webex Identity assigned organization identifier for user's organization.",
"required": true,
"example": "0ae87ade-8c8a-4952-af08-318798958d0c",
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "path",
"description": "Webex Identity assigned user identifier.",
"required": true,
"example": "3426a8e3-d414-4bf0-a493-4f6787632a13",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "add",
"path": "roles",
"value": [
{
"value": "id_user_admin",
"type": "cirole",
"display": "Full Administrator."
}
]
}
]
},
"schema": {
"$ref": "#/components/schemas/PatchUser"
}
}
}
}
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Delete a user",
"operationId": "Delete a user",
"description": "
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_user_admin`\n\n
",
"tags": [
"SCIM 2 Users"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Webex Identity assigned organization identifier for user's organization.",
"required": true,
"example": "0ae87ade-8c8a-4952-af08-318798958d0c",
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "path",
"description": "Webex Identity assigned user identifier.",
"required": true,
"example": "3426a8e3-d414-4bf0-a493-4f6787632a13",
"schema": {
"type": "string"
}
}
]
}
},
"/identity/scim/v2/Users/me": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetUserResponse"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Me",
"operationId": "Get Me",
"description": "
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:people_read`\n\n
\n\nThe API can be used by any user to retrieve user information using their own access token.\n\n
",
"tags": [
"SCIM 2 Users"
],
"parameters": []
}
},
"/admin/securityAudit/events": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {
"link": {
"schema": {
"type": "string"
}
},
"Content-Disposition": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecurityAuditEventCollectionResponse"
},
"example": {
"items": [
{
"data": {
"actorOrgName": "Acme Inc.",
"eventDescription": "An Admin logged in",
"actorName": "Joe Smith",
"actorEmail": "joe@example.com",
"actorUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
"trackingId": "ATLAS_6f23a878-bcd4-c204-a4db-e701b42b0e5c_0",
"eventCategory": "LOGINS",
"actorIp": "128.107.241.191",
"actionText": "Joe Smith logged into organization Acme Inc."
},
"created": "2019-01-02T16:58:36.845Z",
"actorOrgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"id": "MjQ0ODhiZTYtY2FiMS00ZGRkLTk0NWQtZDFlYjkzOGQ4NGUy",
"actorId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZWVmOGE4ZS1lNzg3LTQzMWUtOWM3ZC1hOGVjZmU1MjM5Nzc"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Security Audit Events",
"operationId": "List Security Audit Events",
"description": "List Security Audit Events. This API currently returns user sign-in and sign-out data.\nTo call this API the `audit:events_read` scope must be selected for the Integration or Service App and authorized by a Full Admin.\n\nSeveral query parameters are available to filter the response.\n\nLong result sets will be split into multiple [pages](/docs/basics#pagination)\n\n**NOTE**: A maximum of one year of audit events can be returned per request.",
"tags": [
"Security Audit Events"
],
"parameters": [
{
"name": "orgId",
"in": "query",
"description": "List events in this organization, by ID.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"schema": {
"type": "string"
}
},
{
"name": "startTime",
"in": "query",
"description": "List events which occurred after a specific date and time.",
"required": true,
"example": "2018-01-01T13:12:11.789Z",
"schema": {
"type": "string"
}
},
{
"name": "endTime",
"in": "query",
"description": "List events which occurred before a specific date and time.",
"required": true,
"example": "2018-01-01T14:12:11.789Z",
"schema": {
"type": "string"
}
},
{
"name": "actorId",
"in": "query",
"description": "List events performed by this person, by ID.",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iYzQ1YTdiMC00OTg1LTQzYzktYjI1OS00Y2MzOTgzYzY4NjQ",
"schema": {
"type": "string"
}
},
{
"name": "max",
"in": "query",
"description": "Limit the maximum number of events in the response. The maximum value is `1000`.",
"example": "100",
"schema": {
"type": "number",
"default": 100
}
},
{
"name": "eventCategories",
"in": "query",
"description": "List events, by event categories.",
"example": "LOGINS",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "LOGINS"
},
"description": "List events, by event categories."
}
}
]
}
},
"/identity/organizations/{orgId}/jobs/sendActivationEmails": {
"post": {
"responses": {
"202": {
"description": "Accepted",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkActivationEmailResendJobDetails"
},
"example": {
"name": "resendinviteemail",
"id": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC9lNzc4NWU3YS1mNmFiLTRjNTEtYWVjOS00YTg5NWQyOTdjMjc",
"trackingId": "NA_5c8428d1-dbe9-42c3-bb5d-8f0cd98cea07",
"sourceUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iZmI0YjA5MC1mY2VhLTQ4OGEtOTRmMC0wZWMxODk3ZTIwZGE",
"sourceCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xNjcwNjc3NS00NTQzLTRmZDMtODY3Ny0wYmEwMWYyNTRlZjQ",
"targetCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yMDIwYTkyMC0zMTRjLTQ3NmUtYmNiMS1hNDJhNGI2YzM2MDM",
"instanceId": 3,
"jobExecutionStatus": [
{
"id": 3,
"startTime": "2024-05-16T20:24:24.924Z",
"lastUpdated": "2024-05-16T20:24:24.924Z",
"statusMessage": "STARTED",
"exitCode": "UNKNOWN",
"createdTime": "2024-05-16T20:24:24.888Z",
"timeElapsed": "PT0S"
}
],
"latestExecutionStatus": "STARTED",
"latestExecutionExitCode": "UNKNOWN",
"counts": {
"userResendInviteSent": 0,
"userResendInviteFailed": 0,
"userResendInviteSkipped": 0,
"totalUsers": 0
},
"allowAdminInviteEmails": true
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Initiate Bulk Activation Email Resend Job",
"operationId": "Initiate Bulk Activation Email Resend Job",
"description": "Initiate a bulk activation email resend job that sends an activation email to all eligible users in an organization. Only a single instance of the job can be running for an organization.\n\nRequires a full or user administrator auth token with a scope of `spark-admin:people_write`.",
"tags": [
"Send Activation Email"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Initiate job for this organization.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yMDIwYTkyMC0zMTRjLTQ3NmUtYmNiMS1hNDJhNGI2YzM2MDM",
"schema": {
"type": "string"
}
}
]
}
},
"/identity/organizations/{orgId}/jobs/sendActivationEmails/{jobId}/status": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkActivationEmailResendJobDetails"
},
"example": {
"name": "resendinviteemail",
"id": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC9lNzc4NWU3YS1mNmFiLTRjNTEtYWVjOS00YTg5NWQyOTdjMjc",
"trackingId": "NA_5c8428d1-dbe9-42c3-bb5d-8f0cd98cea07",
"sourceUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iZmI0YjA5MC1mY2VhLTQ4OGEtOTRmMC0wZWMxODk3ZTIwZGE",
"sourceCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xNjcwNjc3NS00NTQzLTRmZDMtODY3Ny0wYmEwMWYyNTRlZjQ",
"targetCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yMDIwYTkyMC0zMTRjLTQ3NmUtYmNiMS1hNDJhNGI2YzM2MDM",
"instanceId": 3,
"jobExecutionStatus": [
{
"id": 3,
"startTime": "2024-05-16T20:24:24.924Z",
"endTime": "2024-05-16T20:24:30.772Z",
"lastUpdated": "2024-05-16T20:24:30.782Z",
"statusMessage": "COMPLETED",
"exitCode": "COMPLETED",
"createdTime": "2024-05-16T20:24:24.888Z",
"stepExecutionStatuses": [
{
"id": 5,
"startTime": "2024-05-16T20:24:24.972Z",
"endTime": "2024-05-16T20:24:30.700Z",
"lastUpdated": "2024-05-16T20:24:30.700Z",
"statusMessage": "COMPLETED",
"exitCode": "COMPLETED",
"name": "resendinviteemailGenerateUserReport",
"timeElapsed": "PT5.728S"
},
{
"id": 6,
"startTime": "2024-05-16T20:24:30.706Z",
"endTime": "2024-05-16T20:24:30.765Z",
"lastUpdated": "2024-05-16T20:24:30.765Z",
"statusMessage": "COMPLETED",
"exitCode": "COMPLETED",
"name": "resendinviteemailProcessUsersFromReport",
"timeElapsed": "PT0.059S"
}
],
"timeElapsed": "PT5.787S"
}
],
"latestExecutionStatus": "COMPLETED",
"latestExecutionExitCode": "COMPLETED",
"counts": {
"userResendInviteSent": 0,
"userResendInviteFailed": 0,
"userResendInviteSkipped": 1,
"totalUsers": 1
},
"allowAdminInviteEmails": true
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Bulk Activation Email Resend Job Status",
"operationId": "Get Bulk Activation Email Resend Job Status",
"description": "Get the details of an activation email resend job by its job ID.\n\nRequires a full or user administrator auth token with a scope of `spark-admin:people_write` or read-only administrator auth token with a scope of `spark-admin:people_read`.",
"tags": [
"Send Activation Email"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Check job status for this organization.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yMDIwYTkyMC0zMTRjLTQ3NmUtYmNiMS1hNDJhNGI2YzM2MDM",
"schema": {
"type": "string"
}
},
{
"name": "jobId",
"in": "path",
"description": "Retrieve job status for this `jobId`.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC9lNzc4NWU3YS1mNmFiLTRjNTEtYWVjOS00YTg5NWQyOTdjMjc",
"schema": {
"type": "string"
}
}
]
}
},
"/identity/organizations/{orgId}/jobs/sendActivationEmails/{jobId}/errors": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {
"Link": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseObject"
},
"example": {
"items": [
{
"itemNumber": 1,
"error": {
"key": "304",
"message": [
{
"description": "Re-send invite for 875ae291-3430-4ccb-85de-3db73ccb31d8 by bfb4b090-fcea-488a-94f0-0ec1897e20da is suppressed as the user 875ae291-3430-4ccb-85de-3db73ccb31d8 has already received an invitation email in last 24 hours ; Error with user@example.com.",
"code": "ATLAS-600199",
"locationId": null
}
]
},
"trackingId": "NA_e0047e0e-804b-4cbc-817a-80c99d5a87a2_1_2"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get Bulk Activation Email Resend Job Errors",
"operationId": "Get Bulk Activation Email Resend Job Errors",
"description": "Get errors of an activation email resend job by its job ID.\n\nRequires a full or user administrator auth token with a scope of `spark-admin:people_write` or read-only administrator auth token with a scope of `spark-admin:people_read`.",
"tags": [
"Send Activation Email"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Check job status for this organization.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yMDIwYTkyMC0zMTRjLTQ3NmUtYmNiMS1hNDJhNGI2YzM2MDM",
"schema": {
"type": "string"
}
},
{
"name": "jobId",
"in": "path",
"description": "Retrieve job status for this `jobId`.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC9lNzc4NWU3YS1mNmFiLTRjNTEtYWVjOS00YTg5NWQyOTdjMjc",
"schema": {
"type": "string"
}
},
{
"name": "max",
"in": "query",
"description": "Limit the maximum number of errors in the response.",
"example": "100",
"schema": {
"type": "number",
"default": 50
}
}
]
}
},
"/applications/{applicationId}/token": {
"post": {
"summary": "Create Service App Access Token",
"description": "Retrieves an organization specific token pair for an already authorized Service App. Service Apps use machine accounts to make API calls on behalf of an organization, independent of individual user life cycles.\n\nThis endpoint allows you to programmatically retrieve access and refresh tokens after a Full Admin has authorized your Service App in Control Hub.\n\nTo call this endpoint, you need an integration with the spark:applications_token scope.",
"operationId": "createServiceAppAccessToken",
"tags": [
"Service Apps"
],
"parameters": [
{
"name": "applicationId",
"in": "path",
"required": true,
"description": "The unique identifier of the Service App",
"schema": {
"type": "string"
},
"example": "Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL0MyNzljYjMwYWI0OTQ3MGFhM2ViYTgwY2Q4MmYxMTc1"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"clientId",
"clientSecret",
"targetOrgId"
],
"properties": {
"clientId": {
"type": "string",
"description": "The OAuth client ID of the Service App",
"example": "C1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
},
"clientSecret": {
"type": "string",
"description": "The OAuth client secret of the Service App",
"format": "password",
"example": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
},
"targetOrgId": {
"type": "string",
"description": "The organization ID for which the token will be created",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successfully created Service App access token",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"access_token": {
"type": "string",
"description": "The OAuth 2.0 access token",
"example": "ZmFrZVRva2VuRm9yRXhhbXBsZVB1cnBvc2VzT25seQ..."
},
"expires_in": {
"type": "integer",
"format": "int64",
"description": "Token expiration time in seconds",
"example": 3600
},
"refresh_token": {
"type": "string",
"description": "The OAuth 2.0 refresh token (if applicable)",
"example": "ZmFrZVJlZnJlc2hUb2tlbkZvckV4YW1wbGVPbmx5..."
},
"refresh_token_expires_in": {
"type": "integer",
"description": "Refresh token expiration time in seconds",
"example": 7776000
},
"token_type": {
"type": "string",
"description": "The type of token issued",
"example": "Bearer"
}
}
},
"example": {
"access_token": "ZmFrZVRva2VuRm9yRXhhbXBsZVB1cnBvc2VzT25seQ...",
"expires_in": 3600,
"refresh_token": "ZmFrZVJlZnJlc2hUb2tlbkZvckV4YW1wbGVPbmx5...",
"refresh_token_expires_in": 7776000,
"token_type": "Bearer"
}
}
}
},
"400": {
"description": "Bad request - Invalid input parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Unauthorized - Authentication required",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Forbidden - Insufficient permissions or Service App not authorized by Full Admin in Control Hub",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Service App not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"security": [
{
"bearerAuth": [
"spark:applications_token"
]
}
]
}
},
"/settings/organizations/{orgId}/settings/{settingKey}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getOrgSettingResponse"
},
"example": {
"key": "allow-admin-invite-emails",
"value": false,
"name": "Automatic Activation Emails"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get an Organization Setting",
"operationId": "Get an Organization Setting",
"description": "This endpoint retrieves the specified setting for the given organization and is accessible with the scope 'identity:organizations_read'.",
"tags": [
"Settings"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The Webex organization id in Control Hub UUID or API orgId format.",
"required": true,
"example": "1eb65fdf-9643-417f-9974-ad72cae0e10f",
"schema": {
"type": "string"
}
},
{
"name": "settingKey",
"in": "path",
"description": "The key of the setting.",
"required": true,
"example": "allow-admin-invite-emails",
"schema": {
"type": "string"
}
}
]
}
},
"/settings/organizations/{orgId}/settings": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getOrgSettingResponse"
},
"example": {
"key": "allow-admin-invite-emails",
"value": false,
"name": "Automatic Activation Emails"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Create or Update an Organization Setting",
"operationId": "Create or Update an Organization Setting",
"description": "This endpoint creates or updates the specified setting for the given organization; however, the 'name' of the setting cannot be modified. It is accessible with the scope 'identity:organizations_rw'.",
"tags": [
"Settings"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The Webex organization id in Control Hub UUID or API orgId format.",
"required": true,
"example": "1eb65fdf-9643-417f-9974-ad72cae0e10f",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"key": "allow-admin-invite-emails",
"value": false
},
"schema": {
"$ref": "#/components/schemas/updateOrgSettingObject"
}
}
}
}
}
},
"/partner/tags": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagsObj"
}
},
"example": [
{
"name": "Tag name",
"description": "Tag description"
}
]
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Retrieve all customer tags",
"operationId": "Retrieve all customer tags",
"description": "Retrieves all tags which are being used by any customer organizations. Once a tag is unassigned from the last customer, it is automatically removed and is not returned by this API.\nThis API can be used by a partner full admin, a read-only partner, or an partner admin. \nThe `type` can have the value ORGANIZATION or SUBSCRIPTION. If not provided, the value is ORGANIZATION",
"tags": [
"Partner Tags"
],
"parameters": [
{
"name": "type",
"in": "query",
"description": "List tags associated with an organization.",
"required": true,
"example": "ORGANIZATION",
"schema": {
"type": "string"
}
}
]
}
},
"/partner/tags/organizations/{orgId}/assignTags": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagsObj"
}
},
"example": [
{
"name": "Tag name",
"description": "Tag description"
}
]
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Create or Replace existing customer tags with the provided ones",
"operationId": "Create or Replace existing customer tags with the provided ones",
"description": "Assign or replace tag(s) which for a customer organization. If the tag doesn't already exist, a new one is created and assigned to the customer automatically.\nThis API can be used by partner full admins and partner admins. \nEach tag has a character limit of 25. Currently, there is a limit of 5 tags per organization when creating tags. To remove all the tags, pass an empty array.\nSpecify the customer organization ID in the `orgId` parameter in the URI.",
"tags": [
"Partner Tags"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The unique identifier for the customer organization.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jOTYwOTZiYi1kYTRhLTQ3NzEtYTc2Zi1kNDEzODQwZWVm1TQ",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagsRequest"
}
}
}
}
}
},
"/partner/tags/organizations/{orgId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerTagsResponse"
},
"example": {
"orgName": "Customer Name",
"orgId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"tags": [
"Tags1",
"Tags2"
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get customer organization's tags",
"operationId": "Get customer organization's tags",
"description": "Retrieve tags associated with a customer organization based on the `orgId` provided.\nThis API can be used by a partner full admin, a read-only partner, or an partner admin. \nSpecify the customer orgId in the `orgId` parameter in the URI.",
"tags": [
"Partner Tags"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Fetch all customers and associated tags for the customer.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jOTYwOTZiYi1kYTRhLTQ3NzEtYTc2Zi1kNDEzODQwZWVm1TQ",
"schema": {
"type": "string"
}
}
]
}
},
"/partner/tags/organizations": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerTagsResponse"
}
},
"example": [
{
"orgName": "Customer Name",
"orgId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"tags": [
"Tags1",
"Tags2"
]
}
]
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Fetch all customers for a given set of tags",
"operationId": "Fetch all customers for a given set of tags",
"description": "For a set of tags, retrieve all customer organizations that match any one of the tags.\nThis API can be used by a partner full admin, a read-only partner, or an partner admin.",
"tags": [
"Partner Tags"
],
"parameters": [
{
"name": "tags",
"in": "query",
"description": "A comma separated list of tags to filter by.",
"required": true,
"example": "Tag1,Tag2",
"schema": {
"type": "string"
}
},
{
"name": "max",
"in": "query",
"description": "Value must be between 1 and 100, inclusive.",
"example": "100",
"schema": {
"type": "number"
}
}
]
}
},
"/partner/tags/organizations/{orgId}/subscriptions/{subscriptionId}/assignTags": {
"post": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagsObj"
}
},
"example": [
{
"name": "Tag name",
"description": "Tag description"
}
]
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Create or Replace existing subscription tags with the provided ones",
"operationId": "Create or Replace existing subscription tags with the provided ones",
"description": "Assign or replace tags specific to each subscription for an organization. Each organization may have one or more subscriptions.\nThis API can be used by partner full admins and partner admins. \nCurrently there is a limit of 5 tags per subscription when creating tags. To remove all the tags, pass an empty array.\nSpecify the customer organization ID in the `orgId` parameter in the URI and subscription ID in `subscriptionId` parameter",
"tags": [
"Partner Tags"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The unique identifier for the customer organization.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jOTYwOTZiYi1kYTRhLTQ3NzEtYTc2Zi1kNDEzODQwZWVm1TQ",
"schema": {
"type": "string"
}
},
{
"name": "subscriptionId",
"in": "path",
"description": "The unique identifier for the subscription.",
"required": true,
"example": "subscriptionId",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagsRequest"
}
}
}
}
}
},
"/partner/tags/subscriptions": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionTagsResponse"
}
},
"example": [
{
"orgName": "Customer Name",
"orgId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"tags": [
"Tags1,Tags2"
],
"subscriptionId": "Sub119911",
"trial": "false"
}
]
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Subscription List on a given tag name or a set of tags",
"operationId": "Subscription List on a given tag name or a set of tags",
"description": "For a partner organization fetch all it's subscriptions with their tag list for a given tag names.\nThis API can be used by partner full admins, partner admins and admin read-only partners.",
"tags": [
"Partner Tags"
],
"parameters": [
{
"name": "tags",
"in": "query",
"description": "A comma separated list of tags to filter by.",
"required": true,
"example": "Tag1,Tag2",
"schema": {
"type": "string"
}
},
{
"name": "max",
"in": "query",
"description": "Value must be between 1 and 100, inclusive.",
"example": "100",
"schema": {
"type": "number"
}
}
]
}
},
"/partner/tags/organizations/{orgId}/subscriptions/{subscriptionId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionTagsResponse"
},
"example": {
"orgName": "Customer Name",
"orgId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"tags": [
"Tags1,Tags2"
],
"subscriptionId": "Sub119911",
"trial": "false"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Fetch a Subscription",
"operationId": "Fetch a Subscription",
"description": "For a given partner org, customer org and external subscription id, fetch subscription details with its associated tags.\nThis API can be used by partner full admins, partner admins and admin read-only partners.",
"tags": [
"Partner Tags"
],
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The unique identifier for the customer organization.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jOTYwOTZiYi1kYTRhLTQ3NzEtYTc2Zi1kNDEzODQwZWVm1TQ",
"schema": {
"type": "string"
}
},
{
"name": "subscriptionId",
"in": "path",
"description": "The unique identifier for the subscription.",
"required": true,
"example": "subscriptionId",
"schema": {
"type": "string"
}
}
]
}
},
"/workspaceLocations": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceLocationsCollectionResponse"
},
"example": {
"items": [
{
"id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzA2OWEzMDY2LTgwNjMtNDI0Zi05YmE0LTBhZDdhMmYxMzNjNQ",
"displayName": "Cisco Barcelona",
"address": "Carrer de Pere IV, Barcelona, Spain",
"countryCode": "ES",
"cityName": "Barcelona",
"latitude": 41.406615,
"longitude": 2.200717,
"notes": "A note about the location"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Workspace Locations",
"operationId": "List Workspace Locations",
"description": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nList workspace locations. Use query parameters to filter the response. The `orgId` parameter can only be used by admin users of another\norganization (such as partners). The `displayName`, `address`, `countryCode` and `cityName` parameters are all optional.\nRequires an administrator auth token with the `spark-admin:workspace_locations_read` scope.",
"tags": [
"Workspace Locations"
],
"parameters": [
{
"name": "orgId",
"in": "query",
"description": "List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"schema": {
"type": "string"
}
},
{
"name": "displayName",
"in": "query",
"description": "Location display name.",
"example": "Cisco Barcelona",
"schema": {
"type": "string"
}
},
{
"name": "address",
"in": "query",
"description": "Location address.",
"example": "Carrer de Pere IV, Barcelona, Spain",
"schema": {
"type": "string"
}
},
{
"name": "countryCode",
"in": "query",
"description": "Location country code (ISO 3166-1).",
"example": "ES",
"schema": {
"type": "string"
}
},
{
"name": "cityName",
"in": "query",
"description": "Location city name.",
"example": "Barcelona",
"schema": {
"type": "string"
}
}
],
"deprecated": true
},
"post": {
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzA2OWEzMDY2LTgwNjMtNDI0Zi05YmE0LTBhZDdhMmYxMzNjNQ",
"displayName": "Cisco Barcelona",
"address": "Carrer de Pere IV, Barcelona, Spain",
"countryCode": "ES",
"cityName": "Barcelona",
"latitude": 41.406615,
"longitude": 2.200717,
"notes": "A note about the location"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Create a Workspace Location",
"operationId": "Create a Workspace Location",
"description": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nCreate a location. The `cityName` and `notes` parameters are optional, and omitting them will result in the creation of a location without values for those attributes.\nRequires an administrator auth token with the `spark-admin:workspace_locations_write` scope.",
"tags": [
"Workspace Locations"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"example": {
"displayName": "Cisco Barcelona",
"address": "Carrer de Pere IV, Barcelona, Spain",
"countryCode": "ES",
"cityName": "Barcelona",
"latitude": 41.406615,
"longitude": 2.200717,
"notes": "A note about the location"
},
"schema": {
"$ref": "#/components/schemas/WorkspaceLocationsCreationRequest"
}
}
}
},
"deprecated": true
}
},
"/workspaceLocations/{locationId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzA2OWEzMDY2LTgwNjMtNDI0Zi05YmE0LTBhZDdhMmYxMzNjNQ",
"displayName": "Cisco Barcelona",
"address": "Carrer de Pere IV, Barcelona, Spain",
"countryCode": "ES",
"cityName": "Barcelona",
"latitude": 41.406615,
"longitude": 2.200717,
"notes": "A note about the location"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get a Workspace Location Details",
"operationId": "Get a Workspace Location Details",
"description": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nShows details for a location, by ID. Specify the location ID in the `locationId` parameter in the URI.\nRequires an administrator auth token with the `spark-admin:workspace_locations_read` scope.",
"tags": [
"Workspace Locations"
],
"parameters": [
{
"name": "locationId",
"in": "path",
"description": "A unique identifier for the location.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"schema": {
"type": "string"
}
}
],
"deprecated": true
},
"put": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Location"
},
"example": {
"id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzA2OWEzMDY2LTgwNjMtNDI0Zi05YmE0LTBhZDdhMmYxMzNjNQ",
"displayName": "Cisco Barcelona",
"address": "Carrer de Pere IV, Barcelona, Spain",
"countryCode": "ES",
"cityName": "Barcelona",
"latitude": 41.406615,
"longitude": 2.200717,
"notes": "A note about the location"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Update a Workspace Location",
"operationId": "Update a Workspace Location",
"description": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nUpdates details for a location, by ID. Specify the location ID in the `locationId` parameter in the URI. The request should include all details for the location returned in a previous call to [Get Workspace Location Details](/docs/api/v1/workspace-locations/get-a-workspace-location-details). Omitting the optional `cityName` or `notes` fields will result in those fields no longer being defined for the location.\nRequires an administrator auth token with the `spark-admin:workspace_locations_write` scope.",
"tags": [
"Workspace Locations"
],
"parameters": [
{
"name": "locationId",
"in": "path",
"description": "A unique identifier for the location.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"displayName": "Cisco Barcelona",
"address": "Carrer de Pere IV, Barcelona, Spain",
"countryCode": "ES",
"cityName": "Barcelona",
"latitude": 41.406615,
"longitude": 2.200717,
"notes": "A note about the location"
},
"schema": {
"$ref": "#/components/schemas/WorkspaceLocationsUpdateRequest"
}
}
}
},
"deprecated": true
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Delete a Workspace Location",
"operationId": "Delete a Workspace Location",
"description": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nDeletes a location, by ID. The workspaces associated to that location will no longer have a location, but a new location can be reassigned to them.\nRequires an administrator auth token with the `spark-admin:workspace_locations_write` scope.",
"tags": [
"Workspace Locations"
],
"parameters": [
{
"name": "locationId",
"in": "path",
"description": "A unique identifier for the location.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"schema": {
"type": "string"
}
}
],
"deprecated": true
}
},
"/workspaceLocations/{locationId}/floors": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceLocationFloorsCollectionResponse"
},
"example": {
"items": [
{
"id": "xxx==",
"locationId": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"floorNumber": -1,
"displayName": "The basement"
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "List Workspace Location Floors",
"operationId": "List Workspace Location Floors",
"description": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nList workspace location floors.\nRequires an administrator auth token with the `spark-admin:workspace_locations_read` scope.",
"tags": [
"Workspace Locations"
],
"parameters": [
{
"name": "locationId",
"in": "path",
"description": "A unique identifier for the location.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"schema": {
"type": "string"
}
}
],
"deprecated": true
},
"post": {
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Floor"
},
"example": {
"id": "xxx==",
"locationId": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"floorNumber": -1,
"displayName": "The basement"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Create a Workspace Location Floor",
"operationId": "Create a Workspace Location Floor",
"description": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nCreate a new floor in the given location. The `displayName` parameter is optional, and omitting it will result in the creation of a floor without that value set.\nRequires an administrator auth token with the `spark-admin:workspace_locations_write` scope.",
"tags": [
"Workspace Locations"
],
"parameters": [
{
"name": "locationId",
"in": "path",
"description": "A unique identifier for the location.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"floorNumber": -1,
"displayName": "The basement"
},
"schema": {
"$ref": "#/components/schemas/WorkspaceLocationFloorsCreationRequest"
}
}
}
},
"deprecated": true
}
},
"/workspaceLocations/{locationId}/floors/{floorId}": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Floor"
},
"example": {
"id": "xxx==",
"locationId": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"floorNumber": -1,
"displayName": "The basement"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Get a Workspace Location Floor Details",
"operationId": "Get a Workspace Location Floor Details",
"description": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nShows details for a floor, by ID. Specify the floor ID in the `floorId` parameter in the URI.\nRequires an administrator auth token with the `spark-admin:workspace_locations_read` scope.",
"tags": [
"Workspace Locations"
],
"parameters": [
{
"name": "locationId",
"in": "path",
"description": "A unique identifier for the location.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"schema": {
"type": "string"
}
},
{
"name": "floorId",
"in": "path",
"description": "A unique identifier for the floor.",
"required": true,
"example": "xx",
"schema": {
"type": "string"
}
}
],
"deprecated": true
},
"put": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FloorUpdated"
},
"example": {
"id": "xxx==",
"locationId": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"floorNumber": 1,
"displayName": "My custom name"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Update a Workspace Location Floor",
"operationId": "Update a Workspace Location Floor",
"description": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nUpdates details for a floor, by ID. Specify the floor ID in the `floorId` parameter in the URI. Include all details for the floor returned by a previous call to [Get Workspace Location Floor Details](/docs/api/v1/workspace-locations/get-a-workspace-location-details). Omitting the optional `displayName` field will result in that field no longer being defined for the floor.\nRequires an administrator auth token with the `spark-admin:workspace_locations_write` scope.",
"tags": [
"Workspace Locations"
],
"parameters": [
{
"name": "locationId",
"in": "path",
"description": "A unique identifier for the location.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"schema": {
"type": "string"
}
},
{
"name": "floorId",
"in": "path",
"description": "A unique identifier for the floor.",
"required": true,
"example": "xx",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"floorNumber": 1,
"displayName": "My custom name"
},
"schema": {
"$ref": "#/components/schemas/WorkspaceLocationFloorsUpdateRequest"
}
}
}
},
"deprecated": true
},
"delete": {
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Delete a Workspace Location Floor",
"operationId": "Delete a Workspace Location Floor",
"description": "The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the [/locations API](/docs/api/v1/locations) for future projects, and use `locationId` instead of `workspaceLocationId` when interacting with device or workspace APIs.
\n\nDeletes a floor, by ID.\nRequires an administrator auth token with the `spark-admin:workspace_locations_write` scope.",
"tags": [
"Workspace Locations"
],
"parameters": [
{
"name": "locationId",
"in": "path",
"description": "A unique identifier for the location.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"schema": {
"type": "string"
}
},
{
"name": "floorId",
"in": "path",
"description": "A unique identifier for the floor.",
"required": true,
"example": "xx",
"schema": {
"type": "string"
}
}
],
"deprecated": true
}
},
"/workspaceMetrics": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceMetricsResponse"
},
"example": {
"workspaceId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"metricName": "temperature",
"aggregation": "hourly",
"from": "2020-10-21T13:33:37.789Z",
"to": "2020-10-31T16:00:00.532Z",
"unit": "celsius",
"sortBy": "newestFirst",
"items": []
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Workspace Metrics",
"operationId": "Workspace Metrics",
"description": "Get metric data for the specified workspace and metric name, optionally aggregated over a specified time period.\n\n* The `workspaceId` and `metricName` parameters indicate which workspace to fetch metrics for and what kind of metrics to get.\n\n* When executing an aggregated query, the result bucket start times will be truncated to the start of an hour or a day, depending on\nthe aggregation interval. However, the buckets will not contain data from outside the requested time range. For example, when\npassing `from=2020-10-21T10:34:56.000Z` and `aggregation=hourly`, the first output bucket would start at `2020-10-21T10:00:00.000Z`,\nbut the bucket would only aggregate data timestamped after `10:34:56`.\n\n* For aggregation modes `none` and `hourly`, the maximum time span is 48 hours. For aggregation mode `daily`, the maximum\ntime span is 30 days.\n\n* If the aggregation mode query parameter is set to `none`, the returned data in the response will be an array of items with the `deviceId`, `timestamp` and the raw `value`.\n\n* If the aggregation mode is `hourly` or `daily`, the returned data in the response will be an array of items with the `start` and `end` of the aggregation time bucket, and the `mean`, `max` and `min` values of the requested value. Note that zeroes and negative values are ignored. For example, this means that the `peopleCount` mean value should be interpreted as the average number of people in the room _when it is in use_.",
"tags": [
"Workspace Metrics"
],
"parameters": [
{
"name": "workspaceId",
"in": "query",
"description": "ID of the workspace to get metrics for.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"schema": {
"type": "string"
}
},
{
"name": "metricName",
"in": "query",
"description": "The type of data to extract.",
"required": true,
"example": "temperature",
"schema": {
"type": "string",
"enum": [
"soundLevel",
"ambientNoise",
"temperature",
"humidity",
"tvoc",
"peopleCount"
]
}
},
{
"name": "aggregation",
"in": "query",
"description": "Time unit over which to aggregate measurements.",
"example": "hourly",
"schema": {
"type": "string",
"default": "hourly",
"enum": [
"none",
"hourly",
"daily"
]
}
},
{
"name": "from",
"in": "query",
"description": "List only data points after a specific date and time (ISO 8601 timestamp)",
"example": "2020-10-21T13:33:37.789Z",
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"description": "List data points before a specific date and time (ISO 8601 timestamp)",
"example": "2020-10-31T16:00:00.532Z",
"schema": {
"type": "string"
}
},
{
"name": "unit",
"in": "query",
"description": "Output data unit (only a valid parameter if `metricName` is `temperature`).",
"example": "celsius",
"schema": {
"type": "string",
"default": "Celsius if the metricName parameter is set to \"temperature\". No default value is provided for other metric names.",
"enum": [
"celsius",
"fahrenheit"
]
}
},
{
"name": "sortBy",
"in": "query",
"description": "Sort results.",
"example": "newestFirst",
"schema": {
"type": "string",
"default": "newestFirst",
"enum": [
"newestFirst",
"oldestFirst"
]
}
}
]
}
},
"/workspaceDurationMetrics": {
"get": {
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceDurationMetricsResponse"
},
"example": {
"workspaceId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"aggregation": "hourly",
"measurement": "timeBooked",
"from": "2020-10-21T13:33:37.789Z",
"to": "2020-10-31T16:00:00.532Z",
"unit": "minutes",
"items": [
{
"start": "2021-10-21T12:00:00Z",
"end": "2021-10-21T13:00:00Z",
"duration": 13
}
]
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "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": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "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": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "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": {
"description": "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": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "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": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"summary": "Workspace Duration Metrics",
"operationId": "Workspace Duration Metrics",
"description": "Get metrics for how much time a workspace has been in the state given by the `measurement` parameter.\n\nFor example, if the measurement is `timeBooked` then the duration for which the workspace has been booked is returned. The `workspaceId` parameter indicates which workspace to fetch metrics for. If no `measurement` is given, the default value is `timeUsed`.\n\n* When executing a query, the result bucket start times will default to the start of an hour or a day, depending on\nthe aggregation interval. However, the buckets will not contain data from outside the requested time range. For example, when\npassing `from=2020-10-21T10:34:56.000Z` and `aggregation=hourly`, the first output bucket would start at `2020-10-21T10:00:00.000Z`,\nbut the bucket would only aggregate data timestamped after `10:34:56`.\n\n* For aggregation mode `hourly`, the maximum time span is 48 hours. For aggregation mode `daily`, the maximum\ntime span is 30 days.",
"tags": [
"Workspace Metrics"
],
"parameters": [
{
"name": "workspaceId",
"in": "query",
"description": "ID of the workspace to get metrics for.",
"required": true,
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"schema": {
"type": "string"
}
},
{
"name": "aggregation",
"in": "query",
"description": "Unit of time over which to aggregate measurements.",
"example": "hourly",
"schema": {
"type": "string",
"default": "hourly",
"enum": [
"hourly",
"daily"
]
}
},
{
"name": "measurement",
"in": "query",
"description": "The measurement to return duration for.",
"example": "timeBooked",
"schema": {
"type": "string",
"default": "timeUsed",
"enum": [
"timeUsed",
"timeBooked"
]
}
},
{
"name": "from",
"in": "query",
"description": "Include data points after a specific date and time (ISO 8601 timestamp).",
"example": "2020-10-21T13:33:37.789Z",
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"description": "Include data points before a specific date and time (ISO 8601 timestamp).",
"example": "2020-10-31T16:00:00.532Z",
"schema": {
"type": "string"
}
}
]
}
}
},
"components": {
"schemas": {
"AcdObject": {
"type": "object",
"required": [
"enabled",
"displayCallqueueAgentSoftkeys"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the ACD object is enabled."
},
"displayCallqueueAgentSoftkeys": {
"$ref": "#/components/schemas/DisplayCallqueueAgentSoftkeysObject",
"description": "Indicates the call queue agent soft key value of an ACD object."
}
}
},
"AcdObjectDevice": {
"type": "object",
"required": [
"enabled",
"displayCallqueueAgentSoftkeys"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the ACD object is enabled."
},
"displayCallqueueAgentSoftkeys": {
"$ref": "#/components/schemas/DisplayCallqueueAgentSoftkeysObject",
"description": "Indicates the call queue agent soft key value of an ACD object."
}
}
},
"ActivationStates": {
"type": "string",
"enum": [
"activating",
"activated",
"deactivated"
],
"description": " * `activating` - Device is activating using an activation code.\n * `activated` - Device has been activated using an activation code.\n * `deactivated` - Device has not been activated using an activation code.\n"
},
"AdminBatchStartJobObjectLocationCustomizations": {
"type": "object",
"properties": {
"locationId": {
"type": "string",
"example": "'Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA'",
"description": "Location within an organization where changes of device setings will be applied to all the devices within it."
},
"locationCustomizationsEnabled": {
"type": "boolean",
"description": "Indicates if all the devices within this location will be customized with new requested customizations(if set to `true`) or will be overridden with the one at organization level (if set to `false` or any other value). This field has no effect when the job is being triggered at organization level."
},
"customizations": {
"$ref": "#/components/schemas/CustomizationObject",
"description": "Indicates the settings for ATA devices, DECT devices and MPP devices."
}
}
},
"AtaDtmfMethodObject": {
"type": "string",
"enum": [
"INBAND",
"AVT",
"AUTO"
],
"description": " * `INBAND` - Sends DTMF by using the audio path.\n * `AVT` - Audio video transport. Sends DTMF as AVT events.\n * `AUTO` - Uses InBand or AVT based on the outcome of codec negotiation.\n"
},
"AtaDtmfModeObject": {
"type": "string",
"enum": [
"STRICT",
"NORMAL"
],
"description": " * `STRICT` - A DTMF digit requires an extra hold time after detection and the DTMF level threshold is raised to -20 dBm.\n * `NORMAL` - Normal threshold mode.\n"
},
"AudioCodecPriorityObject": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"$ref": "#/components/schemas/SelectionType",
"description": "Indicates the selection of an Audio Codec Priority Object."
},
"primary": {
"type": "string",
"example": "G711a",
"description": "Indicates the primary Audio Codec."
},
"secondary": {
"type": "string",
"example": "G711u",
"description": "Indicates the secondary Audio Codec."
},
"tertiary": {
"type": "string",
"example": "G729a",
"description": "Indicates the tertiary Audio Codec."
}
}
},
"AudioCodecPriorityObjectDevice": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"$ref": "#/components/schemas/SelectionType",
"description": "Indicates the selection of an Audio Codec Priority Object."
},
"primary": {
"type": "string",
"example": "G711a",
"description": "Indicates the primary Audio Codec."
},
"secondary": {
"type": "string",
"example": "G711u",
"description": "Indicates the secondary Audio Codec."
},
"tertiary": {
"type": "string",
"example": "G729a",
"description": "Indicates the tertiary Audio Codec."
}
}
},
"AuthenticationMethodObject": {
"type": "string",
"enum": [
"NONE",
"EAP_FAST",
"PEAP_GTC",
"PEAP_MSCHAPV2",
"PSK",
"WEP"
],
"description": " * `NONE` - No authentication.\n * `EAP_FAST` - Extensible Authentication Protocol-Flexible Authentication via Secure Tunneling. Requires username and password authentication.\n * `PEAP_GTC` - Protected Extensible Authentication Protocol - Generic Token Card. Requires username and password authentication.\n * `PEAP_MSCHAPV2` - Protected Extensible Authentication Protocol - Microsoft Challenge Handshake Authentication Protocol version 2. Requires username and password authentication.\n * `PSK` - Pre-Shared Key. Requires shared passphrase for authentication.\n * `WEP` - Wired Equivalent Privacy. Requires encryption key for authentication.\n"
},
"BackgroundImage": {
"type": "string",
"enum": [
"NONE",
"DARK_BLUE",
"CISCO_DARK_BLUE",
"WEBEX_DARK_BLUE",
"CUSTOM_BACKGROUND"
],
"description": " * `NONE` - Indicates that there will be no background image set for the devices.\n * `DARK_BLUE` - Indicates that dark blue background image will be set for the devices.\n * `CISCO_DARK_BLUE` - Indicates that Cisco themed dark blue background image will be set for the devices.\n * `WEBEX_DARK_BLUE` - Indicates that Cisco Webex dark blue background image will be set for the devices.\n * `CUSTOM_BACKGROUND` - Indicates that a custom background image will be set for the devices.\n * `customUrl` - When this option is selected, a field 'Custom Background URL' needs to be added with the image url. URLs provided must link directly to an image file and be in HTTP, HTTPS, or filepath format.\n"
},
"BackgroundImageColor": {
"type": "string",
"enum": [
"CYAN_DARK",
"PURPLE_DARK",
"BLUE_DARK",
"VIOLET_DARK",
"BLUE_LIGHT",
"VIOLET_LIGHT"
],
"description": " * `CYAN_DARK` - Indicates that dark cyan background image will be set for the devices.\n * `PURPLE_DARK` - Indicates the dark purple background image will be set for the devices.\n * `BLUE_DARK` - Indicates the dark blue background image will be set for the devices.\n * `VIOLET_DARK` - Indicates the dark violet background image will be set for the devices.\n * `BLUE_LIGHT` - Indicates the light blue background image will be set for the devices.\n * `VIOLET_LIGHT` - Indicates the light violet background image will be set for the devices.\n"
},
"BacklightTimer68XX": {
"type": "string",
"enum": [
"ALWAYS_ON",
"TEN_SEC",
"TWENTY_SEC",
"THIRTY_SEC",
"OFF"
],
"description": " * `ALWAYS_ON` - Keep the phone's backlight always on.\n * `TEN_SEC` - Set the phone's backlight to be on for ten seconds.\n * `TWENTY_SEC` - Set the phone's backlight to be on for twenty seconds.\n * `THIRTY_SEC` - Set the phone's backlight to be on for thirty seconds.\n * `OFF` - Keep the phone's backlight off.\n"
},
"BacklightTimer68XXDevice": {
"type": "string",
"enum": [
"ALWAYS_ON",
"TEN_SEC",
"TWENTY_SEC",
"THIRTY_SEC",
"OFF"
],
"description": " * `ALWAYS_ON` - Keep the phone's backlight always on.\n * `TEN_SEC` - Set the phone's backlight to be on for ten seconds.\n * `TWENTY_SEC` - Set the phone's backlight to be on for twenty seconds.\n * `THIRTY_SEC` - Set the phone's backlight to be on for thirty seconds.\n * `OFF` - Keep the phone's backlight off.\n"
},
"BacklightTimerObject": {
"type": "string",
"enum": [
"ONE_MIN",
"FIVE_MIN",
"THIRTY_MIN",
"ALWAYS_ON"
],
"description": " * `ONE_MIN` - Set the phone's backlight to be on for one minute.\n * `FIVE_MIN` - Set the phone's backlight to be on for five minutes.\n * `THIRTY_MIN` - Set the phone's backlight to be on for thirty minutes.\n * `ALWAYS_ON` - Keep the phone's backlight always on.\n"
},
"BacklightTimerObjectDevice": {
"type": "string",
"enum": [
"ONE_MIN",
"FIVE_MIN",
"THIRTY_MIN",
"ALWAYS_ON"
],
"description": " * `ONE_MIN` - Set the phone's backlight to be on for one minute.\n * `FIVE_MIN` - Set the phone's backlight to be on for five minutes.\n * `THIRTY_MIN` - Set the phone's backlight to be on for thirty minutes.\n * `ALWAYS_ON` - Keep the phone's backlight always on.\n"
},
"BluetoothObject": {
"type": "object",
"required": [
"enabled",
"mode"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Bluetooth."
},
"mode": {
"type": "string",
"enum": [
"PHONE"
],
"description": "Select a Bluetooth mode."
},
"PHONE": {
"type": "string"
},
"HANDS_FREE": {
"type": "string"
},
"BOTH": {
"type": "string"
}
}
},
"BluetoothObjectDevice": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Bluetooth."
},
"mode": {
"type": "string",
"enum": [
"PHONE",
"HANDS_FREE",
"BOTH"
],
"description": "Select a Bluetooth mode."
}
}
},
"CallForwardExpandedSoftKey": {
"type": "string",
"enum": [
"ONLY_THE_CALL_FORWARD_ALL",
"ALL_CALL_FORWARDS"
],
"description": " * `ONLY_THE_CALL_FORWARD_ALL` - Set the default call forward expanded soft key behavior to single option.\n * `ALL_CALL_FORWARDS` - Set the default call forward expanded soft key behavior to multiple menu option.\n"
},
"CallHistoryMethod": {
"type": "string",
"enum": [
"WEBEX_UNIFIED_CALL_HISTORY",
"LOCAL_CALL_HISTORY"
],
"description": " * `WEBEX_UNIFIED_CALL_HISTORY` - Set call history to use the unified call history from all of the end user's devices.\n * `LOCAL_CALL_HISTORY` - Set call history to use local device information only.\n"
},
"CommSecurityType": {
"type": "string",
"enum": [
"NONE",
"SSL",
"STARTTLS"
],
"description": " * `NONE` - Sets the LDAP server security protocol to None.\n * `SSL` - Sets the LDAP server security protocol to SSL.\n * `STARTTLS` - Sets the LDAP server security protocol to STARTTLS.\n"
},
"Compression": {
"type": "string",
"enum": [
"ON",
"OFF"
],
"description": " * `ON` - Minimize data use during compression.\n * `OFF` - Ignore data use during compression.\n"
},
"CountObject": {
"type": "object",
"required": [
"totalNumbers",
"numbersDeleted",
"numbersMoved",
"numbersFailed"
],
"properties": {
"totalNumbers": {
"type": "number",
"description": "Indicates the total number of phone numbers requested to be moved."
},
"numbersDeleted": {
"type": "number",
"description": "Indicates the total number of phone numbers successfully deleted."
},
"numbersMoved": {
"type": "number",
"description": "Indicates the total number of phone numbers successfully moved."
},
"numbersFailed": {
"type": "number",
"description": "Indicates the total number of phone numbers failed."
}
}
},
"CustomizationDeviceLevelObject": {
"type": "object",
"properties": {
"ata": {
"$ref": "#/components/schemas/ataObject",
"description": "Applicable device settings for an ATA device."
},
"mpp": {
"$ref": "#/components/schemas/mppObject",
"description": "Applicable device settings for an MPP device."
},
"wifi": {
"$ref": "#/components/schemas/wifiObject",
"description": "Applicable device settings for a WiFi device."
}
}
},
"CustomizationDeviceLevelObjectDevice": {
"type": "object",
"properties": {
"ata": {
"$ref": "#/components/schemas/ataObjectDevice",
"description": "Applicable device settings for an ATA device."
},
"mpp": {
"$ref": "#/components/schemas/mppObjectDevice",
"description": "Applicable device settings for an MPP device."
},
"wifi": {
"$ref": "#/components/schemas/wifiObjectDevice",
"description": "Applicable device settings for a WiFi device."
}
}
},
"CustomizationObject": {
"type": "object",
"properties": {
"ata": {
"$ref": "#/components/schemas/ataObject",
"description": "Settings that are applicable to ATA devices."
},
"dect": {
"$ref": "#/components/schemas/dectObject",
"description": "Settings that are applicable to DECT devices."
},
"mpp": {
"$ref": "#/components/schemas/mppObject",
"description": "Settings that are applicable to MPP devices."
},
"wifi": {
"$ref": "#/components/schemas/wifiObject",
"description": "Settings that are applicable to WiFi."
}
}
},
"DectAudioCodecPriorityObject": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"$ref": "#/components/schemas/SelectionType",
"description": "Indicates the selection of an Audio Codec Priority Object."
},
"primary": {
"type": "string",
"example": "G729",
"description": "Indicates the primary Audio Codec."
},
"secondary": {
"type": "string",
"example": "G711u",
"description": "Indicates the secondary Audio Codec."
},
"tertiary": {
"type": "string",
"example": "G711a",
"description": "Indicates the tertiary Audio Codec."
}
}
},
"DectDeviceList": {
"type": "object",
"required": [
"model",
"displayName"
],
"properties": {
"model": {
"type": "string",
"example": "DMS Cisco DBS110",
"description": "Model name of the device."
},
"displayName": {
"type": "string",
"example": "Cisco DECT 210 Base",
"description": "Display name of the device."
},
"numberOfBaseStations": {
"type": "number",
"example": 250,
"description": "Indicates number of base stations."
},
"numberOfLinePorts": {
"type": "number",
"example": 1000,
"description": "Indicates number of port lines,"
},
"numberOfRegistrationsSupported": {
"type": "number",
"example": 30,
"description": "Indicates number of supported registrations."
}
}
},
"DectVlanObject": {
"type": "object",
"required": [
"enabled",
"value"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Denotes whether the VLAN object of DECT is enabled."
},
"value": {
"type": "number",
"description": "Value of the VLAN Object of DECT."
}
}
},
"DefaultLoggingLevelObject": {
"type": "string",
"enum": [
"STANDARD",
"DEBUGGING"
],
"description": " * `STANDARD` - Enables standard logging.\n * `DEBUGGING` - Enables detailed debugging logging.\n"
},
"DeviceActivationStates": {
"type": "string",
"enum": [
"ACTIVATING",
"ACTIVATED",
"DEACTIVATED"
],
"description": " * `ACTIVATING` - Indicates a device is activating.\n * `ACTIVATED` - Indicates a device is activated.\n * `DEACTIVATED` - Indicates a device is deactivated.\n"
},
"DeviceSettingsObject": {
"type": "object",
"required": [
"customizations",
"customEnabled",
"updateInProgress",
"deviceCount",
"lastUpdateTime"
],
"properties": {
"customizations": {
"$ref": "#/components/schemas/CustomizationDeviceLevelObject",
"description": "Indicates the customization object of the device settings."
},
"customEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates if customization is allowed at a location level. If `true`, customized at a location level. If `false`, not customized; uses customer-level configuration."
},
"updateInProgress": {
"type": "boolean",
"example": true,
"description": "Customer devices setting update status. If `true`, an update is in progress (no further changes are allowed). `If false`, no update in progress (changes are allowed)."
},
"deviceCount": {
"type": "number",
"example": 9,
"description": "Number of devices that will be updated."
},
"lastUpdateTime": {
"type": "number",
"example": 1659624763665,
"description": "Indicates the last updated time."
}
}
},
"DeviceSettingsObjectForDeviceLevel": {
"type": "object",
"required": [
"customizations",
"customEnabled",
"updateInProgress",
"deviceCount",
"lastUpdateTime"
],
"properties": {
"customizations": {
"$ref": "#/components/schemas/CustomizationDeviceLevelObjectDevice",
"description": "Indicates the customization object of the device settings."
},
"customEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates if customization is allowed at a device level. If `true`, customized at a device level. If `false`, not customized; uses customer-level configuration."
},
"updateInProgress": {
"type": "boolean",
"example": true,
"description": "Customer devices setting update status. If `true`, an update is in progress (no further changes are allowed). `If false`, no update in progress (changes are allowed)."
},
"deviceCount": {
"type": "number",
"example": 9,
"description": "Number of devices that will be updated."
},
"lastUpdateTime": {
"type": "number",
"example": 1659624763665,
"description": "Indicates the last updated time."
}
}
},
"DirectoryMethod": {
"type": "string",
"enum": [
"XSI_DIRECTORY",
"WEBEX_DIRECTORY"
],
"description": " * `XSI_DIRECTORY` - Set directory services to use standard XSI query method from the device.\n * `WEBEX_DIRECTORY` - Set directory services to use the Webex Enterprise directory.\n"
},
"DisplayCallqueueAgentSoftkeysObject": {
"type": "string",
"enum": [
"FRONT_PAGE",
"LAST_PAGE"
]
},
"DisplayNameSelection": {
"type": "string",
"enum": [
"PERSON_NUMBER",
"PERSON_FIRST_THEN_LAST_NAME",
"PERSON_LAST_THEN_FIRST_NAME"
],
"description": " * `PERSON_NUMBER` - Indicates that devices will display the person's phone number, or if a person doesn't have a phone number, the location number will be displayed.\n * `PERSON_FIRST_THEN_LAST_NAME` - Indicates that devices will display the name in first name then last name format.\n * `PERSON_LAST_THEN_FIRST_NAME` - Indicates that devices will display the name in last name then first name format.\n"
},
"GetMemberResponse": {
"type": "object",
"required": [
"model",
"maxLineCount"
],
"properties": {
"model": {
"type": "string",
"example": "DMS Cisco 192",
"description": "Model type of the device."
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberObject"
},
"description": "List of members that appear on the device."
},
"maxLineCount": {
"type": "number",
"example": 10,
"description": "Maximum number of lines available for the device."
}
}
},
"Hoteling": {
"type": "object",
"required": [
"enabled",
"limitGuestUse"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable/Disable hoteling Host. Enabling the device for hoteling means that a guest(end user) can log into this host(workspace device) and use this device\n\nas if it were their own. This is useful when traveling to a remote office but still needing to place/receive calls with their telephone number and access features normally available to them on their office phone."
},
"limitGuestUse": {
"type": "boolean",
"description": "Enable limiting the time a guest can use the device. The time limit is configured via `guestHoursLimit`."
},
"guestHoursLimit": {
"type": "number",
"description": "Time Limit in hours until hoteling is enabled. Mandatory if `limitGuestUse` is enabled."
}
}
},
"UserHotelingRequestPatch": {
"type": "object",
"required": [
"hoteling"
],
"properties": {
"hoteling": {
"$ref": "#/components/schemas/HotelingRequest",
"description": "Modify person Device Hoteling Setting."
}
}
},
"HotelingRequest": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable/Disable hoteling Host. Enabling the device for hoteling means that a guest(end user) can log into this host(workspace device) and use this device\n\nas if it were their own. This is useful when traveling to a remote office but still needing to place/receive calls with their telephone number and access features normally available to them on their office phone."
},
"limitGuestUse": {
"type": "boolean",
"description": "Enable limiting the time a guest can use the device. The time limit is configured via `guestHoursLimit`."
},
"guestHoursLimit": {
"type": "number",
"description": "Time Limit in hours until hoteling is enabled. Mandatory if `limitGuestUse` is enabled."
}
}
},
"HttpProxyObject": {
"type": "object",
"required": [
"mode",
"autoDiscoveryEnabled",
"host",
"port",
"packUrl",
"authSettingsEnabled",
"username",
"password"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"OFF",
"AUTO",
"MANUAL"
],
"description": "Mode of the HTTP proxy."
},
"autoDiscoveryEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable auto discovery of the URL."
},
"host": {
"type": "string",
"example": "www.example.wxc",
"description": "Specify the host URL if the HTTP mode is set to `MANUAL`."
},
"port": {
"type": "string",
"example": "3128",
"description": "Specify the port if the HTTP mode is set to `MANUAL`."
},
"packUrl": {
"type": "string",
"example": "www.example.wxc",
"description": "Specify PAC URL if auto discovery is disabled."
},
"authSettingsEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable authentication settings."
},
"username": {
"type": "string",
"example": "john",
"description": "Specify a username if authentication settings are enabled."
},
"password": {
"type": "string",
"example": "private",
"description": "Specify a password if authentication settings are enabled."
}
}
},
"HttpProxyObjectDevice": {
"type": "object",
"required": [
"mode",
"autoDiscoveryEnabled"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"OFF",
"AUTO",
"MANUAL"
],
"description": "Mode of the HTTP proxy."
},
"autoDiscoveryEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable auto discovery of the URL."
},
"host": {
"type": "string",
"example": "www.example.wxc",
"description": "Specify the host URL if the HTTP mode is set to `MANUAL`."
},
"port": {
"type": "string",
"example": "3128",
"description": "Specify the port if the HTTP mode is set to `MANUAL`."
},
"packUrl": {
"type": "string",
"example": "www.example.wxc",
"description": "Specify PAC URL if auto discovery is disabled."
},
"authSettingsEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable authentication settings."
},
"username": {
"type": "string",
"example": "john",
"description": "Specify a username if authentication settings are enabled."
},
"password": {
"type": "string",
"example": "private",
"description": "Specify a password if authentication settings are enabled."
}
}
},
"JobListResponse": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StartJobResponse"
},
"description": "Lists all jobs for the customer in order of most recent one to oldest one irrespective of its status."
}
}
},
"LdapObject": {
"type": "object",
"required": [
"enabled",
"serverAddress",
"serverPort",
"commSecurityType",
"bindDn",
"bindPw",
"baseDn",
"primaryEmailAttribute",
"alternateEmailAttribute"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"serverAddress": {
"type": "string",
"example": "localhost",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"serverPort": {
"type": "number",
"example": 8080,
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"commSecurityType": {
"$ref": "#/components/schemas/CommSecurityType",
"description": "Indicates the selection of the protocol for LDAP service on the phone."
},
"bindDn": {
"type": "string",
"example": "bindDn",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"bindPw": {
"type": "string",
"example": "bindPw",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"baseDn": {
"type": "string",
"example": "baseDn",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"primaryEmailAttribute": {
"type": "string",
"example": "primaryEmailAttribute",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"alternateEmailAttribute": {
"type": "string",
"example": "alternateEmailAttribute",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
}
}
},
"LdapObjectDevice": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"serverAddress": {
"type": "string",
"example": "localhost",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"serverPort": {
"type": "number",
"example": 8080,
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"commSecurityType": {
"$ref": "#/components/schemas/CommSecurityType",
"description": "Indicates the selection of the protocol for LDAP service on the phone."
},
"bindDn": {
"type": "string",
"example": "bindDn",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"bindPw": {
"type": "string",
"example": "bindPw",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"baseDn": {
"type": "string",
"example": "baseDn",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"primaryEmailAttribute": {
"type": "string",
"example": "primaryEmailAttribute",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"alternateEmailAttribute": {
"type": "string",
"example": "alternateEmailAttribute",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
}
}
},
"LineKeyLEDPattern": {
"type": "string",
"enum": [
"DEFAULT",
"PRESET_1"
]
},
"LineKeyLabelSelection": {
"type": "string",
"enum": [
"PERSON_EXTENSION",
"PERSON_FIRST_THEN_LAST_NAME",
"PERSON_LAST_THEN_FIRST_NAME"
],
"description": " * `PERSON_EXTENSION` - This will display the person extension, or if a person doesn't have an extension, the person's first name will be displayed.\n * `PERSON_FIRST_THEN_LAST_NAME` - Indicates that devices will display the name in first name then last name format.\n * `PERSON_LAST_THEN_FIRST_NAME` - Indicates that devices will display the name in last name then first name format.\n"
},
"LineType": {
"type": "string",
"enum": [
"PRIMARY",
"SHARED_CALL_APPEARANCE"
],
"description": " * `PRIMARY` - Primary line for the member.\n * `SHARED_CALL_APPEARANCE` - Shared line for the member. A shared line allows users to receive and place calls to and from another user's extension, using their own device.\n"
},
"DeviceLineType": {
"type": "string",
"enum": [
"PRIMARY",
"SHARED_CALL_APPEARANCE",
"MOBILITY",
"HOTDESKING_GUEST"
],
"description": " * `PRIMARY` - Primary line for the member.\n * `SHARED_CALL_APPEARANCE` - Shared line for the member. A shared line allows users to receive and place calls to and from another user's extension, using their own device.\n * `MOBILITY` - Device is a shared line.\n * `HOTDESKING_GUEST` - Device is a hotdesking guest.\n"
},
"ListDectDeviceType": {
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DectDeviceList"
},
"description": "Contains a list of devices."
}
}
},
"ListDeviceSettingsObject": {
"type": "object",
"required": [
"customizations",
"updateInProgress",
"deviceCount",
"lastUpdateTime"
],
"properties": {
"customizations": {
"$ref": "#/components/schemas/CustomizationObject",
"description": "Customization object of the device settings."
},
"updateInProgress": {
"type": "boolean",
"description": "Progress of the device update."
},
"deviceCount": {
"type": "number",
"example": 22,
"description": "Device count."
},
"lastUpdateTime": {
"type": "number",
"example": 1659624763665,
"description": "Last updated time."
}
}
},
"MACAddressResponse": {
"type": "object",
"required": [
"status",
"macStatus"
],
"properties": {
"status": {
"type": "string",
"enum": [
"OK",
"ERRORS"
],
"description": "Status of MAC address."
},
"macStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MacStatusObject"
},
"description": "Contains an array of all the MAC address provided and their statuses."
}
}
},
"MacStatusObject": {
"type": "object",
"required": [
"mac",
"state"
],
"properties": {
"mac": {
"type": "string",
"example": "00005E0053B4",
"description": "MAC address."
},
"state": {
"type": "string",
"enum": [
"AVAILABLE",
"UNAVAILABLE",
"DUPLICATE_IN_LIST",
"INVALID"
],
"description": "State of the MAC address.\n * `AVAILABLE` - The requested MAC address is available.\n * `UNAVAILABLE` - The requested MAC address is unavailable.\n * `DUPLICATE_IN_LIST` - The requested MAC address is duplicated.\n * `INVALID` - The requested MAC address is invalid.\n"
},
"errorCode": {
"type": "number",
"example": 5675,
"description": "MAC address validation error code."
},
"message": {
"type": "string",
"example": "[Error 5675] MAC Address is in use.",
"description": "Provides a status message about the MAC address."
}
}
},
"MemberObject": {
"type": "object",
"required": [
"id",
"firstName",
"lastName",
"primaryOwner",
"port",
"lineType",
"lineWeight",
"hotlineEnabled",
"hotlineDestination",
"allowCallDeclineEnabled",
"memberType"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
"description": "Unique identifier for the member."
},
"firstName": {
"type": "string",
"example": "John",
"description": "First name of a person or workspace."
},
"lastName": {
"type": "string",
"example": "Smith",
"description": "Last name of a person or workspace."
},
"phoneNumber": {
"type": "string",
"example": "2055552221",
"description": "Phone Number of a person or workspace. In some regions phone numbers are not returned in E.164 format. This will be supported in a future update."
},
"extension": {
"type": "string",
"example": "000",
"description": "Extension of a person or workspace."
},
"routingPrefix": {
"type": "string",
"example": "1234",
"description": "Routing prefix of location."
},
"esn": {
"type": "string",
"example": "1234000",
"description": "Routing prefix + extension of a person or workspace."
},
"primaryOwner": {
"type": "boolean",
"example": true,
"description": "This field indicates whether the person or the workspace is the owner of the device, and points to a primary Line/Port of the device."
},
"port": {
"type": "number",
"example": 1,
"description": "Port number assigned to person or workspace."
},
"t38FaxCompressionEnabled": {
"type": "boolean",
"description": "T.38 Fax Compression setting and is available only for ATA Devices. Choose T.38 fax compression if the device requires this option. This will override user level compression options."
},
"lineType": {
"$ref": "#/components/schemas/LineType",
"description": "Line type is used to differentiate Primary and SCA, at which endpoint it is assigned."
},
"lineWeight": {
"type": "number",
"example": 1,
"description": "Number of lines that have been configured for the person on the device."
},
"hostIP": {
"type": "string",
"example": "10.0.0.45",
"description": "Registration Host IP address for the line port."
},
"remoteIP": {
"type": "string",
"example": "192.102.12.84",
"description": "Registration Remote IP address for the line port."
},
"hotlineEnabled": {
"type": "boolean",
"example": true,
"description": "Enable Hotline. Configure this line to automatically call a predefined number whenever taken off-hook. Once enabled, the line can only make calls to the predefined number set in hotlineDestination."
},
"hotlineDestination": {
"type": "string",
"example": "+12055552222",
"description": "The preconfigured number for Hotline. Required only if `hotlineEnabled` is set to true."
},
"allowCallDeclineEnabled": {
"type": "boolean",
"example": true,
"description": "Set how a person's device behaves when a call is declined. When set to true, a call decline request is extended to all the endpoints on the device. When set to false, a call decline request only declines the current endpoint."
},
"lineLabel": {
"type": "string",
"example": "share line label",
"description": "Device line label."
},
"linePort": {
"type": "string",
"example": "evypzco5ds@55552222.int10.bcld.webex.com",
"description": "SIP username used in SIP signaling, for example, in registration."
},
"memberType": {
"$ref": "#/components/schemas/MemberType",
"description": "Indicates if the member is of type `PEOPLE` or `PLACE`."
},
"location": {
"$ref": "#/components/schemas/location",
"description": "Location object having a unique identifier for the location and its name."
}
}
},
"MemberType": {
"type": "string",
"enum": [
"PEOPLE",
"PLACE",
"VIRTUAL_LINE"
],
"description": " * `PEOPLE` - Indicates the associated member is a person.\n * `PLACE` - Indicates the associated member is a workspace.\n * `VIRTUAL_LINE` - Indicates the associated member is a virtual line.\n"
},
"MppAudioCodecPriorityObject": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"type": "string",
"example": "CUSTOM",
"description": "Indicates the selection of the Audio Codec Priority Object for an MPP object."
},
"primary": {
"type": "string",
"example": "OPUS",
"description": "Indicates the primary Audio Codec for an MPP object."
},
"secondary": {
"type": "string",
"example": "G722",
"description": "Indicates the secondary Audio Codec for an MPP object."
},
"tertiary": {
"type": "string",
"example": "G711u",
"description": "Indicates the tertiary Audio Codec for an MPP object."
}
}
},
"MppAudioCodecPriorityObjectDevice": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"$ref": "#/components/schemas/SelectionType",
"description": "Indicates the selection of the Audio Codec Priority Object for an MPP object."
},
"primary": {
"type": "string",
"example": "OPUS",
"description": "Indicates the primary Audio Codec for an MPP object."
},
"secondary": {
"type": "string",
"example": "G722",
"description": "Indicates the secondary Audio Codec for an MPP object."
},
"tertiary": {
"type": "string",
"example": "G711u",
"description": "Indicates the tertiary Audio Codec for an MPP object."
}
}
},
"MppVlanObject": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether the VLAN object of an MPP is enabled."
},
"value": {
"type": "number",
"example": 1,
"description": "Indicates the value of a VLAN object for an MPP object."
},
"pcPort": {
"type": "number",
"example": 1,
"description": "Indicates the PC port value of a VLAN object for an MPP object."
}
}
},
"MppVlanObjectDevice": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether the VLAN object of an MPP is enabled."
},
"value": {
"type": "number",
"example": 1,
"description": "Indicates the value of a VLAN object for an MPP object."
},
"pcPort": {
"type": "number",
"example": 1,
"description": "Indicates the PC port value of a VLAN object for an MPP object."
}
}
},
"NoiseCancellationObject": {
"type": "object",
"required": [
"enabled",
"allowEndUserOverrideEnabled"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the Noise Cancellation."
},
"allowEndUserOverrideEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable to preserve the existing values on the phone and not the value defined for the device setting."
}
}
},
"PhoneLanguage": {
"type": "string",
"enum": [
"PERSON_LANGUAGE",
"ARABIC",
"BULGARIAN",
"CATALAN",
"CHINESE_SIMPLIFIED",
"CHINESE_TRADITIONAL",
"CROATIAN",
"CZECH",
"DANISH",
"DUTCH",
"ENGLISH_UNITED_STATES",
"ENGLISH_UNITED_KINGDOM",
"FINNISH",
"FRENCH_CANADA",
"FRENCH_FRANCE",
"GERMAN",
"GREEK",
"HEBREW",
"HUNGARIAN",
"ITALIAN",
"JAPANESE",
"KOREAN",
"NORWEGIAN",
"POLISH",
"PORTUGUESE_PORTUGAL",
"RUSSIAN",
"SPANISH_COLOMBIA",
"SPANISH_SPAIN",
"SLOVAK",
"SWEDISH",
"SLOVENIAN",
"TURKISH",
"UKRAINE"
],
"description": " * `PERSON_LANGUAGE` - Indicates a person's announcement language.\n"
},
"PoeMode": {
"type": "string",
"enum": [
"NORMAL",
"MAXIMUM"
],
"description": " * `NORMAL` - Use normal power consumption.\n * `MAXIMUM` - Use maximum power consumption.\n"
},
"PskObject": {
"type": "object",
"required": [
"psk1",
"psk4"
],
"properties": {
"psk1": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK1."
},
"psk2": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK2."
},
"psk3": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK3."
},
"psk4": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK4."
},
"psk5": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK5."
},
"psk6": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK6."
},
"psk7": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK7."
},
"psk8": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK8."
},
"psk9": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK9."
},
"psk10": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK10."
},
"psk11": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK11."
},
"psk12": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK12."
},
"psk13": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK13."
},
"psk14": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK14."
},
"psk15": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK15."
},
"psk16": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK16."
}
}
},
"PutDeviceSettingsRequest": {
"type": "object",
"required": [
"customizations",
"customEnabled"
],
"properties": {
"customizations": {
"$ref": "#/components/schemas/CustomizationDeviceLevelObjectDevice",
"description": "Indicates the customization object of the device settings."
},
"customEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates if customization is allowed at a device level. If true, customized at a device level. If false, not customized; uses customer-level configuration."
}
}
},
"PutMemberObject": {
"type": "object",
"required": [
"port",
"id",
"primaryOwner",
"lineType",
"lineWeight",
"hotlineEnabled",
"hotlineDestination",
"allowCallDeclineEnabled"
],
"properties": {
"port": {
"type": "number",
"example": 1,
"description": "Person's assigned port number."
},
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
"description": "Unique identifier for the member."
},
"t38FaxCompressionEnabled": {
"type": "boolean",
"description": "T.38 Fax Compression setting and is available only for ATA Devices. Choose T.38 fax compression if the device requires this option. This will override user level compression options."
},
"primaryOwner": {
"type": "boolean",
"example": true,
"description": "Whether the user is the owner of the device or not, and points to a primary Line/Port of device."
},
"lineType": {
"$ref": "#/components/schemas/LineType",
"description": "Line type is used to differentiate Primary and SCA, at which endpoint it is assigned."
},
"lineWeight": {
"type": "number",
"example": 1,
"description": "Number of lines that have been configured for the person on the device."
},
"hotlineEnabled": {
"type": "boolean",
"example": true,
"description": "Enable Hotline. Configure this line to automatically call a predefined number whenever taken off-hook. Once enabled, the line can only make calls to the predefined number set in hotlineDestination."
},
"hotlineDestination": {
"type": "string",
"example": "+12055552222",
"description": "The preconfigured number for Hotline. Required only if `hotlineEnabled` is set to true."
},
"allowCallDeclineEnabled": {
"type": "boolean",
"example": true,
"description": "Set how a person's device behaves when a call is declined. When set to true, a call decline request is extended to all the endpoints on the device. When set to false, a call decline request only declines the current endpoint."
},
"lineLabel": {
"type": "string",
"example": "share line label",
"description": "Device line label."
}
}
},
"PutMembersRequest": {
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PutMemberObject"
},
"description": "This specifies the new list of device members, completely replacing the existing device members. If the member's list is omitted then all the users are removed except the primary user."
}
}
},
"ScreenTimeoutObject": {
"type": "object",
"required": [
"enabled",
"value"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the Screen Time object is enabled."
},
"value": {
"type": "number",
"example": 400,
"description": "Indicates the value of screen timeout."
}
}
},
"SearchMemberObject": {
"type": "object",
"required": [
"id",
"firstName",
"lastName",
"lineType",
"allowCallDeclineEnabled",
"memberType"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
"description": "Unique identifier for the member."
},
"firstName": {
"type": "string",
"example": "John",
"description": "First name of a person or workspace."
},
"lastName": {
"type": "string",
"example": "Smith",
"description": "Last name of a person or workspace."
},
"phoneNumber": {
"type": "string",
"example": "+12055552221",
"description": "Phone Number of a person or workspace."
},
"t38FaxCompressionEnabled": {
"type": "boolean",
"description": "T.38 Fax Compression setting and available only for ATA Devices. Choose T.38 fax compression if the device requires this option. this will override user level compression options."
},
"lineType": {
"$ref": "#/components/schemas/LineType",
"description": "Line type is used to differentiate Primary and SCA, at which endpoint it is assigned."
},
"allowCallDeclineEnabled": {
"type": "boolean",
"example": true,
"description": "Set how a person's device behaves when a call is declined. When set to true, a call decline request is extended to all the endpoints on the device. When set to false, a call decline request only declines the current endpoint."
},
"memberType": {
"$ref": "#/components/schemas/MemberType",
"description": "Indicates if member is of type `PEOPLE` or `PLACE`."
},
"location": {
"$ref": "#/components/schemas/location",
"description": "Location object having a unique identifier for the location and its name."
}
}
},
"SearchMemberResponse": {
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchMemberObject"
},
"description": "List of members available for the device."
}
}
},
"SelectionType": {
"type": "string",
"enum": [
"REGIONAL",
"CUSTOM"
],
"description": " * `REGIONAL` - Indicates the regional selection type for audio codec priority.\n * `CUSTOM` - Indicates the custom selection type for audio codec priority.\n"
},
"SnmpObject": {
"type": "object",
"required": [
"enabled",
"trustedIP",
"getCommunity",
"setCommunity",
"snmpV3Enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Denotes whether the Simple Network Management Protocol of an ATA is enabled."
},
"trustedIP": {
"type": "string",
"example": "10.0.0.45",
"description": "Trusted IPv4 address and subnet mask in this order: 0.0.0.0/0.0.0.0."
},
"getCommunity": {
"type": "string",
"example": "public",
"description": "Read-only community string that allows/denies access to other device's statistics. Default value is `public`."
},
"setCommunity": {
"type": "string",
"example": "private",
"description": "Read-write community string that protects the device against unauthorized changes. Must never be set to `public`."
},
"snmpV3Enabled": {
"type": "boolean",
"description": "Denotes whether the SNMPv3 security is enabled."
}
}
},
"SoftKeyLayoutObject": {
"type": "object",
"required": [
"softKeyMenu",
"psk",
"softKeyMenuDefaults",
"pskDefaults"
],
"properties": {
"softKeyMenu": {
"$ref": "#/components/schemas/SoftKeyMenuObject",
"description": "Customize SoftKey menu settings."
},
"psk": {
"$ref": "#/components/schemas/PskObject",
"description": "Customize PSK."
},
"softKeyMenuDefaults": {
"$ref": "#/components/schemas/SoftKeyMenuObject",
"description": "Default SoftKey menu settings."
},
"pskDefaults": {
"$ref": "#/components/schemas/PskObject",
"description": "Default PSK."
}
}
},
"SoftKeyMenuObject": {
"type": "object",
"required": [
"idleKeyList",
"offHookKeyList",
"dialingInputKeyList",
"progressingKeyList",
"connectedKeyList",
"connectedVideoKeyList",
"startTransferKeyList",
"startConferenceKeyList",
"conferencingKeyList",
"releasingKeyList",
"holdKeyList",
"ringingKeyList",
"sharedActiveKeyList",
"sharedHeldKeyList"
],
"properties": {
"idleKeyList": {
"type": "string",
"example": "guestin|;guestout|;acd_login|;acd_logout|;astate|;redial|;newcall|;cfwd|;recents|;dnd|;unpark|;psk1|;gpickup|;pickup|;dir|4;miss|5;selfview|;messages",
"description": "Specify the idle key list."
},
"offHookKeyList": {
"type": "string",
"example": "endcall|1;redial|2;dir|3;lcr|4;unpark|5;pickup|6;gpickup|7",
"description": "Specify the off hook key list."
},
"dialingInputKeyList": {
"type": "string",
"example": "dial|1;cancel|2;delchar|3;left|5;right|6",
"description": "Specify the dialing input key list."
},
"progressingKeyList": {
"type": "string",
"example": "endcall|2",
"description": "Specify the progressing key list."
},
"connectedKeyList": {
"type": "string",
"example": "hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume",
"description": "Specify the connected key list."
},
"connectedVideoKeyList": {
"type": "string",
"example": "hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume",
"description": "Specify the connected video key list."
},
"startTransferKeyList": {
"type": "string",
"example": "endcall|2;xfer|3",
"description": "Start the transfer key list."
},
"startConferenceKeyList": {
"type": "string",
"example": "endcall|2;conf|3",
"description": "Start the conference key list."
},
"conferencingKeyList": {
"type": "string",
"example": "endcall;join;crdstart;crdstop;crdpause;crdresume",
"description": "Specify the conferencing key list."
},
"releasingKeyList": {
"type": "string",
"example": "endcall|2",
"description": "Specify the releasing key list."
},
"holdKeyList": {
"type": "string",
"example": "resume|1;endcall|2;newcall|3;redial|4;dir|5",
"description": "Specify the hold key list."
},
"ringingKeyList": {
"type": "string",
"example": "answer|1;ignore|2",
"description": "Specify the ringing key list."
},
"sharedActiveKeyList": {
"type": "string",
"example": "newcall|1;psk1|2;dir|3;back|4",
"description": "Specify the shared active key list."
},
"sharedHeldKeyList": {
"type": "string",
"example": "resume|1;dir|4",
"description": "Specify the shared held key list."
}
}
},
"StartJobResponse": {
"type": "object",
"required": [
"name",
"id",
"jobType",
"trackingId",
"sourceUserId",
"sourceCustomerId",
"targetCustomerId",
"instanceId",
"latestExecutionStatus",
"operationType",
"sourceLocationId",
"targetLocationId",
"counts"
],
"properties": {
"name": {
"type": "string",
"description": "Job name."
},
"id": {
"type": "string",
"description": "Unique identifier of the job."
},
"jobType": {
"type": "string",
"description": "Job type."
},
"trackingId": {
"type": "string",
"description": "Unique identifier to track the flow of HTTP requests."
},
"sourceUserId": {
"type": "string",
"description": "Unique identifier to identify which user has run the job."
},
"sourceCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer who has run the job."
},
"targetCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer for which the job was run."
},
"instanceId": {
"type": "number",
"description": "Unique identifier to identify the instance of the job."
},
"jobExecutionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobExecutionStatusObject1"
},
"description": "Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job."
},
"latestExecutionStatus": {
"type": "string",
"description": "Indicates the most recent status (STARTING, STARTED, COMPLETED, FAILED) of the job at the time of invocation."
},
"latestExecutionExitCode": {
"type": "string",
"enum": [
"UNKNOWN",
"COMPLETED",
"FAILED",
"STOPPED",
"COMPLETED_WITH_ERRORS"
],
"description": "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n"
},
"operationType": {
"type": "string",
"description": "Indicates operation type that was carried out."
},
"sourceLocationId": {
"type": "string",
"description": "Unique location identifier for which the job was run."
},
"targetLocationId": {
"type": "string",
"description": "Unique location identifier for which the numbers have been moved."
},
"counts": {
"$ref": "#/components/schemas/CountObject",
"description": "Job statistics."
}
}
},
"UsbPortsObject": {
"type": "object",
"required": [
"enabled",
"sideUsbEnabled",
"rearUsbEnabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "New Control to Enable/Disable the side USB port."
},
"sideUsbEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable use of the side USB port on the MPP device. Enabled by default."
},
"rearUsbEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable use of the rear USB port on the MPP device."
}
}
},
"ValidateMACRequest": {
"type": "object",
"required": [
"macs"
],
"properties": {
"macs": {
"type": "array",
"items": {
"type": "string",
"example": "ab125678cdef,00005E0053B4"
},
"description": "MAC addresses to be validated."
}
}
},
"VlanObject": {
"type": "object",
"required": [
"enabled",
"value"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Denotes whether the VLAN object of an ATA is enabled."
},
"value": {
"type": "number",
"example": 1,
"description": "The value of the VLAN Object of an ATA object."
}
}
},
"VlanObjectDevice": {
"type": "object",
"required": [
"enabled",
"value"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Denotes whether the VLAN object of an ATA is enabled."
},
"value": {
"type": "number",
"example": 1,
"description": "The value of the VLAN Object of an ATA object."
}
}
},
"VolumeSettingsObject": {
"type": "object",
"required": [
"ringerVolume",
"speakerVolume",
"handsetVolume",
"headsetVolume",
"eHookEnabled",
"allowEndUserOverrideEnabled"
],
"properties": {
"ringerVolume": {
"type": "number",
"example": 9,
"description": "Specify a ringer volume level through a numeric value between 0 and 15."
},
"speakerVolume": {
"type": "number",
"example": 11,
"description": "Specify a speaker volume level through a numeric value between 0 and 15."
},
"handsetVolume": {
"type": "number",
"example": 10,
"description": "Specify a handset volume level through a numeric value between 0 and 15."
},
"headsetVolume": {
"type": "number",
"example": 10,
"description": "Specify a headset volume level through a numeric value between 0 and 15."
},
"eHookEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the wireless headset hookswitch control."
},
"allowEndUserOverrideEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable to preserve the existing values on the phone and not the values defined for the device settings."
}
}
},
"WebAccessObject": {
"type": "object",
"required": [
"enabled",
"password"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Ability to enable or disable the web browser access for the 840/860."
},
"password": {
"type": "string",
"example": "password",
"description": "Ability to set a Web Server Password."
}
}
},
"WifiAudioCodecPriorityObject": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"$ref": "#/components/schemas/SelectionType",
"description": "Indicates the selection of the Audio Codec Priority Object for an WiFi object."
},
"primary": {
"type": "string",
"example": "OPUS",
"description": "Indicates the primary Audio Codec for an WiFi object."
},
"secondary": {
"type": "string",
"example": "G722",
"description": "Indicates the secondary Audio Codec for an WiFi object."
},
"tertiary": {
"type": "string",
"example": "G711u",
"description": "Indicates the tertiary Audio Codec for an WiFi object."
}
}
},
"WifiAudioCodecPriorityObjectDevice": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"type": "string",
"example": "CUSTOM",
"description": "Indicates the selection of the Audio Codec Priority Object for an WiFi object."
},
"primary": {
"type": "string",
"example": "OPUS",
"description": "Indicates the primary Audio Codec for an WiFi object."
},
"secondary": {
"type": "string",
"example": "G722",
"description": "Indicates the secondary Audio Codec for an WiFi object."
},
"tertiary": {
"type": "string",
"example": "G711u",
"description": "Indicates the tertiary Audio Codec for an WiFi object."
}
}
},
"WifiNetworkObject": {
"type": "object",
"required": [
"enabled",
"authenticationMethod",
"ssidName",
"userId"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether the wifi network is enabled."
},
"authenticationMethod": {
"$ref": "#/components/schemas/AuthenticationMethodObject",
"description": "Authentication method of wifi network."
},
"ssidName": {
"type": "string",
"example": "my_wifi_network",
"description": "SSID name of the wifi network."
},
"userId": {
"type": "string",
"example": "test-user",
"description": "User Id of the wifi network."
}
}
},
"WifiNetworkObjectDevice": {
"type": "object",
"required": [
"enabled",
"authenticationMethod",
"ssidName",
"userId"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether the wifi network is enabled."
},
"authenticationMethod": {
"$ref": "#/components/schemas/AuthenticationMethodObject",
"description": "Authentication method of the WiFi network."
},
"ssidName": {
"type": "string",
"example": "my_wifi_network",
"description": "SSID name of the wifi network."
},
"userId": {
"type": "string",
"example": "test-user",
"description": "User ID for the WiFi network."
}
}
},
"ataObject": {
"type": "object",
"required": [
"audioCodecPriority",
"ataDtmfMode",
"ataDtmfMethod",
"cdpEnabled",
"lldpEnabled",
"qosEnabled",
"vlan",
"webAccessEnabled",
"nightlyResyncEnabled",
"snmp"
],
"properties": {
"audioCodecPriority": {
"$ref": "#/components/schemas/AudioCodecPriorityObject",
"description": "Choose up to three predefined codec priority options available for your region."
},
"ataDtmfMode": {
"$ref": "#/components/schemas/AtaDtmfModeObject",
"description": "DTMF Detection Tx Mode selection for Cisco ATA devices."
},
"ataDtmfMethod": {
"$ref": "#/components/schemas/AtaDtmfMethodObject",
"description": "Method for transmitting DTMF signals to the far end."
},
"cdpEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Cisco Discovery Protocol for local devices."
},
"lldpEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Link Layer Discovery Protocol for local devices."
},
"qosEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable quality of service tagging of packets from the local device to the Webex Calling platform."
},
"vlan": {
"$ref": "#/components/schemas/VlanObject",
"description": "Specify a numeric Virtual LAN ID for devices."
},
"webAccessEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable user level web access to the local device."
},
"nightlyResyncEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the automatic nightly configuration resync of the MPP device."
},
"snmp": {
"$ref": "#/components/schemas/SnmpObject",
"description": "Specify values needed to enable use of the SNMP service from the phone."
}
}
},
"ataObjectDevice": {
"type": "object",
"required": [
"audioCodecPriority",
"ataDtmfMode",
"ataDtmfMethod",
"cdpEnabled",
"lldpEnabled",
"qosEnabled",
"vlan",
"webAccessEnabled",
"nightlyResyncEnabled",
"snmp"
],
"properties": {
"audioCodecPriority": {
"$ref": "#/components/schemas/AudioCodecPriorityObjectDevice",
"description": "Choose up to three predefined codec priority options available for your region."
},
"ataDtmfMode": {
"$ref": "#/components/schemas/AtaDtmfModeObject",
"description": "DTMF Detection Tx Mode selection for Cisco ATA devices."
},
"ataDtmfMethod": {
"$ref": "#/components/schemas/AtaDtmfMethodObject",
"description": "Method for transmitting DTMF signals to the far end."
},
"cdpEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Cisco Discovery Protocol for local devices."
},
"lldpEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Link Layer Discovery Protocol for local devices."
},
"qosEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable quality of service tagging of packets from the local device to the Webex Calling platform."
},
"vlan": {
"$ref": "#/components/schemas/VlanObjectDevice",
"description": "Specify a numeric Virtual LAN ID for devices."
},
"webAccessEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable user level web access to the local device."
},
"nightlyResyncEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the automatic nightly configuration resync of the MPP device."
},
"snmp": {
"$ref": "#/components/schemas/SnmpObject",
"description": "Specify values needed to enable use of the SNMP service from the phone."
}
}
},
"dectObject": {
"type": "object",
"required": [
"audioCodecPriority",
"cdpEnabled",
"dect6825HandsetEmergencyNumber",
"lldpEnabled",
"multicast",
"qosEnabled",
"vlan",
"webAccessEnabled",
"nightlyResyncEnabled"
],
"properties": {
"audioCodecPriority": {
"$ref": "#/components/schemas/DectAudioCodecPriorityObject",
"description": "Choose up to three predefined codec priority options available for your region."
},
"cdpEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Cisco Discovery Protocol for local devices."
},
"dect6825HandsetEmergencyNumber": {
"type": "string",
"description": "Specify the destination number to be dialled from the DECT Handset top button when pressed."
},
"lldpEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Link Layer Discovery Protocol for local devices."
},
"multicast": {
"type": "string",
"description": "Specify up to 3 multicast group URLs each with a unique listening port."
},
"qosEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable quality of service tagging of packets from the local device to the Webex Calling platform."
},
"vlan": {
"$ref": "#/components/schemas/DectVlanObject",
"description": "Specify a numeric Virtual LAN ID for devices."
},
"webAccessEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable user level web access to the local device."
},
"nightlyResyncEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable phone's default behavior regarding the nightly maintenance synchronization with the Webex Calling platform."
}
}
},
"deviceList": {
"type": "object",
"required": [
"devices",
"maxDeviceCount",
"maxOwnedDeviceCount"
],
"properties": {
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/devices"
},
"description": "Array of devices available to person."
},
"maxDeviceCount": {
"type": "number",
"description": "Maximum number of devices a person can be assigned to."
},
"maxOwnedDeviceCount": {
"type": "number",
"description": "Maximum number of devices a person can own."
}
}
},
"deviceOwner": {
"type": "object",
"required": [
"id",
"type",
"firstName",
"lastName"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of a person or a workspace."
},
"type": {
"$ref": "#/components/schemas/MemberType",
"description": "Enumeration that indicates if the member is of type `PEOPLE` or `PLACE`."
},
"firstName": {
"type": "string",
"description": "First name of device owner."
},
"lastName": {
"type": "string",
"description": "Last name of device owner."
}
}
},
"devices": {
"type": "object",
"required": [
"id",
"model",
"primaryOwner",
"type",
"hoteling",
"owner",
"activationState"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for a device."
},
"description": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma separated array of tags used to describe device."
},
"model": {
"type": "string",
"description": "Identifier for device model."
},
"modelType": {
"$ref": "#/components/schemas/DeviceType",
"description": "Identifier for device model type."
},
"mac": {
"type": "string",
"description": "MAC address of device."
},
"ipAddress": {
"type": "string",
"description": "IP address of device."
},
"primaryOwner": {
"type": "boolean",
"description": "Indicates whether the person or the workspace is the owner of the device, and points to a primary Line/Port of the device."
},
"type": {
"$ref": "#/components/schemas/DeviceLineType",
"description": "Indicates if the line is acting as a primary line or a shared line for this device."
},
"hoteling": {
"$ref": "#/components/schemas/HotelingRequest",
"description": "Hoteling login settings, which are available when the device is the owner's primary device and device type is PRIMARY. Hoteling login settings are set at the owner level."
},
"owner": {
"$ref": "#/components/schemas/deviceOwner",
"description": "Owner of device."
},
"activationState": {
"$ref": "#/components/schemas/ActivationStates",
"description": "Activation state of device."
}
}
},
"DeviceType": {
"type": "string",
"enum": [
"MPP",
"ATA",
"GENERIC_SIP",
"ESIM",
"ROOM_OS",
"MOBILE",
"DESK_PHONE"
],
"description": " * `MPP` - Cisco Multiplatform Phone\n * `ATA` - Analog Telephone Adapters\n * `GENERIC_SIP` - GENERIC Session Initiation Protocol\n * `ESIM` - Esim Supported Webex Go\n * `ROOM_OS` - Cisco Webex Room OS and the Room Series device\n * `MOBILE` - Mobile\n * `DESK_PHONE` - Desk Phone\n"
},
"jobIdResponseObject": {
"type": "object",
"required": [
"name",
"id",
"jobType",
"trackingId",
"sourceUserId",
"sourceCustomerId",
"targetCustomerId",
"instanceId",
"latestExecutionStatus",
"operationType",
"sourceLocationId",
"targetLocationId",
"sourceLocationName",
"targetLocationName",
"counts"
],
"properties": {
"name": {
"type": "string",
"description": "Job name."
},
"id": {
"type": "string",
"description": "Unique identifier of the job."
},
"jobType": {
"type": "string",
"description": "Job type."
},
"trackingId": {
"type": "string",
"description": "Unique identifier to track the flow of HTTP requests."
},
"sourceUserId": {
"type": "string",
"description": "Unique identifier to identify which user has run the job."
},
"sourceCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer who has run the job."
},
"targetCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer for which the job was run."
},
"instanceId": {
"type": "number",
"description": "Unique identifier to identify the instance of the job."
},
"jobExecutionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobExecutionStatusObject"
},
"description": "Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job."
},
"latestExecutionStatus": {
"type": "string",
"description": "Indicates the most recent status (STARTING, STARTED, COMPLETED, FAILED) of the job at the time of invocation."
},
"latestExecutionExitCode": {
"type": "string",
"enum": [
"UNKNOWN",
"COMPLETED",
"FAILED",
"STOPPED",
"COMPLETED_WITH_ERRORS"
],
"description": "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n"
},
"operationType": {
"type": "string",
"description": "Indicates the operation type that was carried out."
},
"sourceLocationId": {
"type": "string",
"description": "Unique location identifier for which the job was run."
},
"targetLocationId": {
"type": "string",
"description": "Unique location identifier for which the numbers have been moved."
},
"sourceLocationName": {
"type": "string",
"description": "The location name for which the job was run."
},
"targetLocationName": {
"type": "string",
"description": "The location name for which the numbers have been moved."
},
"counts": {
"$ref": "#/components/schemas/CountObject",
"description": "Job statistics."
}
}
},
"location": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw",
"description": "Location identifier associated with the members."
},
"name": {
"type": "string",
"example": "MainOffice",
"description": "Location name associated with the member."
}
}
},
"mppObject": {
"type": "object",
"required": [
"pnacEnabled",
"audioCodecPriority",
"backlightTimer",
"background",
"cdpEnabled",
"defaultLoggingLevel",
"dndServicesEnabled",
"acd",
"shortInterdigitTimer",
"longInterdigitTimer",
"lineKeyLabelFormat",
"lineKeyLEDPattern",
"lldpEnabled",
"mppUserWebAccessEnabled",
"multicast",
"enhancedMulticast",
"offHookTimer",
"phoneLanguage",
"poeMode",
"qosEnabled",
"screenTimeout",
"usbPortsEnabled",
"vlan",
"wifiNetwork",
"callHistory",
"contacts",
"webexMeetingsEnabled",
"volumeSettings",
"cfExpandedSoftKey",
"httpProxy",
"bluetooth",
"passThroughPortEnabled",
"userPasswordOverrideEnabled",
"activeCallFocusEnabled",
"peerFirmwareEnabled",
"noiseCancellation",
"voiceFeedbackAccessibilityEnabled",
"dialAssistEnabled",
"callsPerLine",
"nightlyResyncEnabled",
"missedCallNotificationEnabled",
"softKeyLayout",
"backgroundImage8875",
"backlightTimer68XX78XX",
"allowMonitorLinesEnabled"
],
"properties": {
"pnacEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the PNAC of MPP object is enabled or not."
},
"audioCodecPriority": {
"$ref": "#/components/schemas/MppAudioCodecPriorityObject",
"description": "Choose up to three predefined codec priority options available for your region."
},
"backlightTimer": {
"$ref": "#/components/schemas/BacklightTimerObject",
"description": "Choose the length of time (in minutes) for the phone's backlight to remain on."
},
"background": {
"type": "object",
"properties": {
"image": {
"$ref": "#/components/schemas/BackgroundImage"
},
"customUrl": {
"type": "string"
}
}
},
"displayNameFormat": {
"$ref": "#/components/schemas/DisplayNameSelection",
"description": "The display name that appears on the phone screen."
},
"cdpEnabled": {
"type": "boolean",
"description": "Allows you to enable/disable CDP for local devices."
},
"defaultLoggingLevel": {
"$ref": "#/components/schemas/DefaultLoggingLevelObject",
"description": "Choose the desired logging level for an MPP devices."
},
"dndServicesEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Do-Not-Disturb capabilities for Multi-Platform Phones."
},
"acd": {
"$ref": "#/components/schemas/AcdObject",
"description": "Holds the Acd object value."
},
"shortInterdigitTimer": {
"type": "number",
"example": 14,
"description": "Indicates the short inter digit timer value."
},
"longInterdigitTimer": {
"type": "number",
"example": 16,
"description": "Indicates the long inter digit timer value.."
},
"lineKeyLabelFormat": {
"$ref": "#/components/schemas/LineKeyLabelSelection",
"description": "Line key labels define the format of what's shown next to line keys."
},
"lineKeyLEDPattern": {
"$ref": "#/components/schemas/LineKeyLEDPattern",
"description": "LED patterns define lighting schemes for the line keys on the MPP devices. Note that this parameter is not supported on the MPP 8875"
},
"lldpEnabled": {
"type": "boolean",
"description": "Enable/disable Link Layer Discovery Protocol for local devices."
},
"mppUserWebAccessEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable user-level access to the web interface of Multi-Platform Phones."
},
"multicast": {
"type": "array",
"items": {
"type": "string",
"example": "[\"192.86.108.226:22\"]"
},
"description": "Select up to 10 Multicast Group URLs (each with a unique Listening Port)."
},
"enhancedMulticast": {
"$ref": "#/components/schemas/EnhancedMulticastObject",
"description": "Specify the enhanced multicast settings for the MPP device."
},
"offHookTimer": {
"type": "number",
"example": 30,
"description": "Specify the amount of time (in seconds) that a phone can remain off-hook."
},
"phoneLanguage": {
"$ref": "#/components/schemas/PhoneLanguage",
"description": "Select the language for your MPP phone. Setting this overrides the default language setting in place for your provisioned location."
},
"poeMode": {
"$ref": "#/components/schemas/PoeMode",
"description": "Enable/disable the Power-Over-Ethernet mode for Multi-Platform Phones."
},
"qosEnabled": {
"type": "boolean",
"example": true,
"description": "Allows you to enable/disable tagging of packets from the local device to the Webex Calling platform."
},
"screenTimeout": {
"$ref": "#/components/schemas/ScreenTimeoutObject",
"description": "Specify the amount of inactive time needed (in seconds) before the phone's screen saver activates."
},
"usbPortsEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the use of the USB ports on Multi-Platform phones."
},
"vlan": {
"$ref": "#/components/schemas/MppVlanObject",
"description": "Specify a numeric Virtual LAN ID for devices."
},
"wifiNetwork": {
"$ref": "#/components/schemas/WifiNetworkObject",
"description": "Specify the Wi-Fi SSID and password for wireless-enabled MPP phones."
},
"callHistory": {
"$ref": "#/components/schemas/CallHistoryMethod",
"description": "Specify the call history information to use. Only applies to user devices."
},
"contacts": {
"$ref": "#/components/schemas/DirectoryMethod",
"description": "Specify the directory services to use."
},
"webexMeetingsEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the availability of the webex meetings functionality from the phone."
},
"volumeSettings": {
"$ref": "#/components/schemas/VolumeSettingsObject",
"description": "Specify all volume level values on the phone."
},
"cfExpandedSoftKey": {
"$ref": "#/components/schemas/CallForwardExpandedSoftKey",
"description": "Specify the call forward expanded soft key behavior."
},
"httpProxy": {
"$ref": "#/components/schemas/HttpProxyObject",
"description": "Specify HTTP Proxy values."
},
"bluetooth": {
"$ref": "#/components/schemas/BluetoothObject",
"description": "Enable/disable the visibility of the bluetooth menu on the MPP device."
},
"passThroughPortEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the use of the PC passthrough ethernet port on supported phone models."
},
"userPasswordOverrideEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the ability for an end user to set a local password on the phone to restrict local access to the device."
},
"activeCallFocusEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the default screen behavior when inbound calls are received."
},
"peerFirmwareEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable peer firmware sharing."
},
"noiseCancellation": {
"$ref": "#/components/schemas/NoiseCancellationObject",
"description": "Enable/disable local noise cancellation on active calls from the device."
},
"voiceFeedbackAccessibilityEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable visibility of the Accessibility Voice Feedback menu on the MPP device."
},
"dialAssistEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable availability of dial assist feature on the phone."
},
"callsPerLine": {
"type": "number",
"example": 9,
"description": "Specify the number of calls per unique line appearance on the phone."
},
"nightlyResyncEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable automatic nightly configuration resync of the MPP device."
},
"missedCallNotificationEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the visual indication of missed calls."
},
"softKeyLayout": {
"$ref": "#/components/schemas/SoftKeyLayoutObject",
"description": "Specify the softkey layout per phone menu state."
},
"backgroundImage8875": {
"$ref": "#/components/schemas/BackgroundImageColor",
"description": "Specify the image option for the MPP 8875 phone background."
},
"backlightTimer68XX78XX": {
"$ref": "#/components/schemas/BacklightTimer68XX",
"description": "Specify the use of the backlight feature on 6800 nad 7800 series devices."
},
"allowMonitorLinesEnabled": {
"type": "boolean",
"description": "Enable/disable monitoring for MPP non-primary device."
},
"iceEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable SIP media streams to go directly between phones on the same local network."
}
}
},
"mppObjectDevice": {
"type": "object",
"required": [
"pnacEnabled",
"audioCodecPriority",
"backlightTimer",
"background",
"cdpEnabled",
"defaultLoggingLevel",
"dndServicesEnabled",
"acd",
"shortInterdigitTimer",
"longInterdigitTimer",
"lineKeyLabelFormat",
"lineKeyLEDPattern",
"lldpEnabled",
"mppUserWebAccessEnabled",
"multicast",
"enhancedMulticast",
"offHookTimer",
"phoneLanguage",
"poeMode",
"qosEnabled",
"screenTimeout",
"usbPortsEnabled",
"usbPorts",
"vlan",
"wifiNetwork",
"callHistory",
"contacts",
"webexMeetingsEnabled",
"volumeSettings",
"cfExpandedSoftKey",
"httpProxy",
"bluetooth",
"passThroughPortEnabled",
"userPasswordOverrideEnabled",
"activeCallFocusEnabled",
"peerFirmwareEnabled",
"noiseCancellation",
"voiceFeedbackAccessibilityEnabled",
"dialAssistEnabled",
"callsPerLine",
"nightlyResyncEnabled",
"missedCallNotificationEnabled",
"softKeyLayout",
"backgroundImage8875",
"backlightTimer68XX78XX",
"allowMonitorLinesEnabled"
],
"properties": {
"pnacEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the PNAC of MPP object is enabled or not."
},
"audioCodecPriority": {
"$ref": "#/components/schemas/MppAudioCodecPriorityObjectDevice",
"description": "Choose up to three predefined codec priority options available for your region."
},
"backlightTimer": {
"$ref": "#/components/schemas/BacklightTimerObjectDevice",
"description": "Choose the length of time (in minutes) for the phone's backlight to remain on."
},
"background": {
"type": "object",
"properties": {
"image": {
"$ref": "#/components/schemas/BackgroundImage"
},
"customUrl": {
"type": "string"
}
}
},
"displayNameFormat": {
"$ref": "#/components/schemas/DisplayNameSelection",
"description": "The display name that appears on the phone screen."
},
"cdpEnabled": {
"type": "boolean",
"description": "Allows you to enable/disable CDP for local devices."
},
"defaultLoggingLevel": {
"$ref": "#/components/schemas/DefaultLoggingLevelObject",
"description": "Choose the desired logging level for an MPP devices."
},
"dndServicesEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Do-Not-Disturb capabilities for Multi-Platform Phones."
},
"acd": {
"$ref": "#/components/schemas/AcdObjectDevice",
"description": "Holds the Acd object value."
},
"shortInterdigitTimer": {
"type": "number",
"example": 14,
"description": "Indicates the short inter digit timer value."
},
"longInterdigitTimer": {
"type": "number",
"example": 16,
"description": "Indicates the long inter digit timer value.."
},
"lineKeyLabelFormat": {
"$ref": "#/components/schemas/LineKeyLabelSelection",
"description": "Line key labels define the format of what's shown next to line keys."
},
"lineKeyLEDPattern": {
"$ref": "#/components/schemas/LineKeyLEDPattern",
"description": "LED patterns define lighting schemes for the line keys on the MPP devices. Note that this parameter is not supported on the MPP 8875"
},
"lldpEnabled": {
"type": "boolean",
"description": "Enable/disable Link Layer Discovery Protocol for local devices."
},
"mppUserWebAccessEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable user-level access to the web interface of Multi-Platform Phones."
},
"multicast": {
"type": "array",
"items": {
"type": "string",
"example": "[\"192.86.108.226:22\"]"
},
"description": "Select up to 10 Multicast Group URLs (each with a unique Listening Port)."
},
"enhancedMulticast": {
"$ref": "#/components/schemas/EnhancedMulticastObject",
"description": "Specify the enhanced multicast settings for the MPP device."
},
"offHookTimer": {
"type": "number",
"example": 30,
"description": "Specify the amount of time (in seconds) that a phone can remain off-hook."
},
"phoneLanguage": {
"$ref": "#/components/schemas/PhoneLanguage",
"description": "Select the language for your MPP phone. Setting this overrides the default language setting in place for your provisioned location."
},
"poeMode": {
"$ref": "#/components/schemas/PoeMode",
"description": "Enable/disable the Power-Over-Ethernet mode for Multi-Platform Phones."
},
"qosEnabled": {
"type": "boolean",
"example": true,
"description": "Allows you to enable/disable tagging of packets from the local device to the Webex Calling platform."
},
"screenTimeout": {
"$ref": "#/components/schemas/ScreenTimeoutObject",
"description": "Specify the amount of inactive time needed (in seconds) before the phone's screen saver activates."
},
"usbPortsEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the use of the USB ports on Multi-Platform phones."
},
"usbPorts": {
"$ref": "#/components/schemas/UsbPortsObject",
"description": "By default the Side USB port is enabled to support KEMs and other peripheral devices. Use the option to disable use of this port."
},
"vlan": {
"$ref": "#/components/schemas/MppVlanObjectDevice",
"description": "Specify a numeric Virtual LAN ID for devices."
},
"wifiNetwork": {
"$ref": "#/components/schemas/WifiNetworkObjectDevice",
"description": "Specify the Wi-Fi SSID and password for wireless-enabled MPP phones."
},
"callHistory": {
"$ref": "#/components/schemas/CallHistoryMethod",
"description": "Specify the call history information to use. Only applies to user devices."
},
"contacts": {
"$ref": "#/components/schemas/DirectoryMethod",
"description": "Specify the directory services to use."
},
"webexMeetingsEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the availability of the webex meetings functionality from the phone."
},
"volumeSettings": {
"$ref": "#/components/schemas/VolumeSettingsObject",
"description": "Specify all volume level values on the phone."
},
"cfExpandedSoftKey": {
"$ref": "#/components/schemas/CallForwardExpandedSoftKey",
"description": "Specify the call forward expanded soft key behavior."
},
"httpProxy": {
"$ref": "#/components/schemas/HttpProxyObjectDevice",
"description": "Specify HTTP Proxy values."
},
"bluetooth": {
"$ref": "#/components/schemas/BluetoothObjectDevice",
"description": "Enable/disable the visibility of the bluetooth menu on the MPP device."
},
"passThroughPortEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the use of the PC passthrough ethernet port on supported phone models."
},
"userPasswordOverrideEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the ability for an end user to set a local password on the phone to restrict local access to the device."
},
"activeCallFocusEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the default screen behavior when inbound calls are received."
},
"peerFirmwareEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable peer firmware sharing."
},
"noiseCancellation": {
"$ref": "#/components/schemas/NoiseCancellationObject",
"description": "Enable/disable local noise cancellation on active calls from the device."
},
"voiceFeedbackAccessibilityEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable visibility of the Accessibility Voice Feedback menu on the MPP device."
},
"dialAssistEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable availability of dial assist feature on the phone."
},
"callsPerLine": {
"type": "number",
"example": 9,
"description": "Specify the number of calls per unique line appearance on the phone."
},
"nightlyResyncEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable automatic nightly configuration resync of the MPP device."
},
"missedCallNotificationEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the visual indication of missed calls."
},
"softKeyLayout": {
"$ref": "#/components/schemas/SoftKeyLayoutObject",
"description": "Specify the softkey layout per phone menu state."
},
"backgroundImage8875": {
"$ref": "#/components/schemas/BackgroundImageColor",
"description": "Specify the image option for the MPP 8875 phone background."
},
"backlightTimer68XX78XX": {
"$ref": "#/components/schemas/BacklightTimer68XXDevice",
"description": "Specify the use of the backlight feature on 6800 nad 7800 series devices."
},
"allowMonitorLinesEnabled": {
"type": "boolean",
"description": "Enable/disable monitoring for MPP non-primary device."
},
"iceEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable SIP media streams to go directly between phones on the same local network."
}
}
},
"placeDeviceList": {
"type": "object",
"required": [
"devices",
"maxDeviceCount",
"maxOwnedDeviceCount"
],
"properties": {
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/placeDevices"
},
"description": "Array of devices associated with a workspace."
},
"maxDeviceCount": {
"type": "number",
"description": "Maximum number of devices a workspace can be assigned to."
},
"maxOwnedDeviceCount": {
"type": "number",
"description": "Maximum number of devices a workspace can own."
}
}
},
"placeDevices": {
"type": "object",
"required": [
"id",
"model",
"primaryOwner",
"type",
"hoteling",
"owner",
"activationState"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for a device."
},
"description": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma separated array of tags used to describe device."
},
"model": {
"type": "string",
"description": "Identifier for device model."
},
"mac": {
"type": "string",
"description": "MAC address of device."
},
"ipAddress": {
"type": "string",
"description": "IP address of device."
},
"primaryOwner": {
"type": "boolean",
"description": "Indicates whether the person or the workspace is the owner of the device and points to a primary Line/Port of the device."
},
"type": {
"$ref": "#/components/schemas/LineType",
"description": "Indicates if the line is acting as a primary line or a shared line for this device."
},
"hoteling": {
"$ref": "#/components/schemas/Hoteling",
"description": "Indicates Hoteling details of a device."
},
"owner": {
"$ref": "#/components/schemas/deviceOwner",
"description": "Owner of the device."
},
"activationState": {
"$ref": "#/components/schemas/DeviceActivationStates",
"description": "Activation state of a device."
}
}
},
"wifiObject": {
"type": "object",
"required": [
"audioCodecPriority",
"ldap",
"webAccess",
"phoneSecurityPwd"
],
"properties": {
"audioCodecPriority": {
"$ref": "#/components/schemas/WifiAudioCodecPriorityObject",
"description": "Choose up to three predefined codec priority options available for your region."
},
"ldap": {
"$ref": "#/components/schemas/LdapObject",
"description": "Set the values needed to enable use of the LDAP service on the phone."
},
"webAccess": {
"$ref": "#/components/schemas/WebAccessObject",
"description": "Set the availability of the local end user web access for an 840/860 WiFi phone."
},
"phoneSecurityPwd": {
"type": "string",
"example": "phoneSecurityPwd",
"description": "Set the local security password on an 840/860 WiFi phone."
}
}
},
"wifiObjectDevice": {
"type": "object",
"required": [
"audioCodecPriority",
"ldap",
"webAccess",
"phoneSecurityPwd"
],
"properties": {
"audioCodecPriority": {
"$ref": "#/components/schemas/WifiAudioCodecPriorityObjectDevice",
"description": "Choose up to three predefined codec priority options available for your region."
},
"ldap": {
"$ref": "#/components/schemas/LdapObjectDevice",
"description": "Set the values needed to enable use of the LDAP service on the phone."
},
"webAccess": {
"$ref": "#/components/schemas/WebAccessObject",
"description": "Set the availability of the local end user web access for an 840/860 WiFi phone."
},
"phoneSecurityPwd": {
"type": "string",
"example": "phoneSecurityPwd",
"description": "Set the local security password on an 840/860 WiFi phone."
}
}
},
"GetLineKeyTemplateResponse": {
"type": "object",
"required": [
"id",
"templateName",
"deviceModel",
"modelDisplayName",
"userReorderEnabled",
"lineKeys"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS81NzVhMWY3Zi03MjRkLTRmZGUtODk4NC1mNjNhNDljMzYxZmQ",
"description": "Unique identifier for the Line Key Template."
},
"templateName": {
"type": "string",
"example": "Basic Template",
"description": "Name of the Line Key Template."
},
"deviceModel": {
"type": "string",
"example": "'DMS Cisco 6821'",
"description": "The Device Model for which the Line Key Template is applicable."
},
"modelDisplayName": {
"type": "string",
"example": "Cisco 6821",
"description": "The friendly display name used to represent the device model in Control Hub."
},
"userReorderEnabled": {
"type": "boolean",
"description": "Indicates whether user can reorder the line keys."
},
"lineKeys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgrammableLineKeys"
},
"description": "Contains a mapping of Line Keys and their corresponding actions."
}
}
},
"LineKeyType": {
"type": "string",
"enum": [
"PRIMARY_LINE",
"SHARED_LINE",
"MONITOR",
"CALL_PARK_EXTENSION",
"SPEED_DIAL",
"OPEN",
"CLOSED",
"MODE_MANAGEMENT"
],
"description": " * `PRIMARY_LINE` - PRIMARY_LINE is the user's primary extension. This is the default assignment for Line Key Index 1 and cannot be modified.\n * `SHARED_LINE` - Shows the appearance of other users on the owner's phone.\n * `MONITOR` - Enables User and Call Park monitoring.\n * `CALL_PARK_EXTENSION` - Enables the configure layout feature in Control Hub to set call park extension implicitly.\n * `SPEED_DIAL` - Allows users to reach a telephone number, extension or a SIP URI.\n * `OPEN` - An open key will automatically take the configuration of a monitor button starting with the first open key. These buttons are also usable by the user to configure speed dial numbers on these keys.\n * `CLOSED` - Button not usable but reserved for future features.\n * `MODE_MANAGEMENT` - Allows users to manage call forwarding for features via schedule-based routing.\n"
},
"ApplyLineKeyTemplateJobList": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplyLineKeyTemplateJobDetails"
},
"description": "List of Apply Line Key Template jobs."
}
}
},
"ApplyLineKeyTemplateJobDetails": {
"type": "object",
"required": [
"name",
"id",
"trackingId",
"sourceUserId",
"sourceCustomerId",
"targetCustomerId",
"instanceId",
"latestExecutionStatus",
"percentageComplete",
"updatedCount",
"advisoryCount"
],
"properties": {
"name": {
"type": "string",
"description": "Job name."
},
"id": {
"type": "string",
"description": "Unique identifier of the job."
},
"trackingId": {
"type": "string",
"description": "Unique identifier to track the flow of HTTP requests."
},
"sourceUserId": {
"type": "string",
"description": "Unique identifier to identify which user has run the job."
},
"sourceCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer who has run the job."
},
"targetCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer for which the job was run."
},
"instanceId": {
"type": "number",
"description": "Unique identifier to identify the instance of the job."
},
"jobExecutionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobExecutionStatusObject"
},
"description": "Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job."
},
"latestExecutionStatus": {
"type": "string",
"description": "Indicates the most recent status (`STARTING`, `STARTED`, `COMPLETED`, `FAILED`) of the job at the time of invocation."
},
"latestExecutionExitCode": {
"type": "string",
"enum": [
"UNKNOWN",
"COMPLETED",
"FAILED",
"STOPPED",
"COMPLETED_WITH_ERRORS"
],
"description": "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n"
},
"percentageComplete": {
"type": "integer",
"description": "Indicates the progress of the job."
},
"updatedCount": {
"type": "integer",
"description": "Number of job steps completed."
},
"advisoryCount": {
"type": "integer",
"description": "Number of job steps completed with advisories."
}
}
},
"ApplyLineKeyTemplateJobErrors": {
"type": "object",
"required": [
"trackingId"
],
"properties": {
"trackingId": {
"type": "string",
"description": "Unique identifier to track the HTTP requests."
},
"error": {
"$ref": "#/components/schemas/ErrorMessageObject",
"description": "Description of errors in the job."
}
}
},
"LineKeyTemplateAdvisoryTypes": {
"type": "object",
"properties": {
"moreSharedAppearancesEnabled": {
"type": "boolean",
"example": true,
"description": "Refine search to apply changes to devices that contain the warning \"More shared/virtual line appearances than shared/virtual lines requested\"."
},
"fewSharedAppearancesEnabled": {
"type": "boolean",
"example": true,
"description": "Refine search to apply changes to devices that contain the warning \"More shared/virtual lines requested than shared/virtual line appearances\"."
},
"moreMonitorAppearancesEnabled": {
"type": "boolean",
"example": true,
"description": "Refine search to apply changes to devices that contain the warning \"More monitored line appearances than monitored lines in the user's monitoring list\"."
},
"moreCPEAppearancesEnabled": {
"type": "boolean",
"example": true,
"description": "Refine search to apply changes to devices that contain the warning \"More call park extension line appearances than call park extensions in user's monitoring list\"."
},
"moreModeManagementAppearancesEnabled": {
"type": "boolean",
"example": true,
"description": "Refine search to apply changes to devices that contain the warning \"More mode management lines configured for the device\". The default value is false."
}
}
},
"PostApplyLineKeyTemplateRequest": {
"type": "object",
"required": [
"action",
"templateId"
],
"properties": {
"action": {
"type": "string",
"enum": [
"APPLY_TEMPLATE",
"APPLY_DEFAULT_TEMPLATES"
],
"description": "Line key Template action to perform.\n * `APPLY_TEMPLATE` - Used to apply LinekeyTemplate to devices.\n * `APPLY_DEFAULT_TEMPLATES` - Used to reset devices to its default Linekey Template configurations.\n"
},
"templateId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL1VTL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM=",
"description": "`templateId` is required for `APPLY_TEMPLATE` action."
},
"locationIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Used to search for devices only in the given locations."
},
"excludeDevicesWithCustomLayout": {
"type": "boolean",
"description": "Indicates whether to exclude devices with custom layout."
},
"includeDeviceTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Include devices only with these tags."
},
"excludeDeviceTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Exclude devices with these tags."
},
"advisoryTypes": {
"$ref": "#/components/schemas/LineKeyTemplateAdvisoryTypes",
"description": "Refine search with advisories."
}
}
},
"PostLineKeyTemplateRequest": {
"type": "object",
"required": [
"templateName",
"deviceModel",
"lineKeys"
],
"properties": {
"templateName": {
"type": "string",
"example": "template for 8845",
"description": "Name of the Line Key Template."
},
"deviceModel": {
"type": "string",
"example": "DMS Cisco 8845",
"description": "The model of the device for which the Line Key Template is applicable. The corresponding device model display name sometimes called the product name, can also be used to specify the model."
},
"userReorderEnabled": {
"type": "boolean",
"example": true,
"description": "User Customization Enabled."
},
"lineKeys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgrammableLineKeys"
},
"description": "Contains a mapping of Line Keys and their corresponding actions."
}
}
},
"ProgrammableLineKeys": {
"type": "object",
"required": [
"lineKeyIndex",
"lineKeyType",
"sharedLineIndex"
],
"properties": {
"lineKeyIndex": {
"type": "number",
"example": 2,
"description": "An index representing a Line Key. Index starts from 1 representing the first key on the left side of the phone."
},
"lineKeyType": {
"$ref": "#/components/schemas/LineKeyType",
"description": "The action that would be performed when the Line Key is pressed."
},
"lineKeyLabel": {
"type": "string",
"example": "Help Line",
"description": "This is applicable only when the lineKeyType is `SPEED_DIAL`."
},
"lineKeyValue": {
"type": "string",
"example": "5646",
"description": "Applicable only when the `lineKeyType` is `SPEED_DIAL`. Value must be a valid telephone number, ext, or SIP URI (format: `user@host` using A-Z,a-z,0-9,-_ .+ for `user` and `host`)."
},
"sharedLineIndex": {
"type": "number",
"example": 4,
"description": "Shared line index is the line label number of the shared or virtual line assigned in the configured lines. Since you can add multiple appearances of the same shared or virtual line on a phone, entering the index number assigns the respective line to a line key. This is applicable only when the `lineKeyType` is SHARED_LINE. `sharedLineIndex` starts at 1 and increments by one for each shared line."
}
}
},
"PutLineKeyTemplateRequest": {
"type": "object",
"required": [
"lineKeys"
],
"properties": {
"userReorderEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the user can reorder the line keys."
},
"lineKeys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgrammableLineKeys"
},
"description": "List of line keys that are being updated."
}
}
},
"lineKeyTemplatesResponse": {
"type": "object",
"required": [
"id",
"templateName",
"deviceModel",
"modelDisplayName"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL1VTL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM=",
"description": "Unique identifier for the Line Key Template."
},
"templateName": {
"type": "string",
"example": "template for 8845",
"description": "Name of the Line Key Template."
},
"deviceModel": {
"type": "string",
"example": "DMS Cisco 8845",
"description": "The Device Model for which the Line Key Template is applicable."
},
"modelDisplayName": {
"type": "string",
"example": "Cisco 8845",
"description": "The friendly display name used to represent the device model in Control Hub."
}
}
},
"GetThirdPartyDeviceObject": {
"type": "object",
"required": [
"manufacturer",
"managedBy",
"id",
"ip",
"model",
"upgradeChannelEnabled"
],
"properties": {
"manufacturer": {
"type": "string",
"example": "THIRD_PARTY",
"description": "Manufacturer of the device."
},
"managedBy": {
"type": "string",
"example": "CUSTOMER",
"description": "Device manager(s)."
},
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3",
"description": "A unique identifier for the device."
},
"ip": {
"type": "string",
"example": "100.110.120.130",
"description": "The current IP address of the device."
},
"mac": {
"type": "string",
"example": "11223344AAFF",
"description": "The unique address for the network adapter."
},
"model": {
"type": "string",
"example": "DMS Cisco 8811",
"description": "A model type of the device."
},
"activationState": {
"$ref": "#/components/schemas/ActivationStates",
"description": "Activation state of the device. This field is only populated for a device added by a unique activation code generated by Control Hub for use with Webex."
},
"description": {
"type": "array",
"items": {
"type": "string",
"example": "device description"
},
"description": "Comma-separated array of tags used to describe the device."
},
"upgradeChannelEnabled": {
"type": "boolean",
"example": true,
"description": "Enabled / disabled status of the upgrade channel."
},
"owner": {
"type": "object",
"required": [
"sipUserName"
],
"properties": {
"sipUserName": {
"type": "string",
"example": "392829",
"description": "SIP authentication user name for the owner of the device."
},
"linePort": {
"type": "string",
"example": "lg1_sias10_cpapi16004_LGU@64941297.int10.bcld.webex.com",
"description": "Identifies a device endpoint in standalone mode or a SIP URI public identity in IMS mode."
}
}
},
"proxy": {
"type": "object",
"properties": {
"outboundProxy": {
"type": "string",
"example": "hs17.hosted-int.bcld.webex.com",
"description": "Outgoing server which the phone should use for all SIP requests. Not set if the response has no body."
}
}
}
}
},
"PutThirdPartyDevice": {
"type": "object",
"required": [
"sipPassword"
],
"properties": {
"sipPassword": {
"type": "string",
"example": "Test4Password123&",
"description": "Password to be updated."
}
}
},
"DeviceLayout": {
"type": "object",
"required": [
"layoutMode",
"lineKeys"
],
"properties": {
"layoutMode": {
"$ref": "#/components/schemas/LayoutMode",
"description": "Defines the layout mode of the device, i.e. DEFAULT or CUSTOM."
},
"userReorderEnabled": {
"type": "boolean",
"example": true,
"description": "If `true`, user customization is enabled."
},
"lineKeys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgrammableLineKeys"
},
"description": "Contains a mapping of Line Keys and their corresponding actions."
},
"kemModuleType": {
"$ref": "#/components/schemas/KemModuleType",
"description": "Type of KEM module."
},
"kemKeys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/KEMKeys"
},
"description": "Contains a mapping of KEM Keys and their corresponding actions. For KEM keys not included in the request, they will be set to OPEN."
}
}
},
"KEMKeys": {
"type": "object",
"required": [
"kemModuleIndex",
"kemKeyIndex",
"kemKeyType",
"sharedLineIndex"
],
"properties": {
"kemModuleIndex": {
"type": "number",
"example": 1,
"description": "An index representing a KEM Module. The Index starts from 1 representing the first KEM Module."
},
"kemKeyIndex": {
"type": "number",
"example": 1,
"description": "An index representing a KEM Key. The Index starts from 1 representing the first key on the left side of the phone."
},
"kemKeyType": {
"$ref": "#/components/schemas/LineKeyType",
"description": "The action that would be performed when the KEM Key is pressed."
},
"kemKeyLabel": {
"type": "string",
"example": "Office",
"description": "Applicable only when the kemKeyType is `SPEED_DIAL`."
},
"kemKeyValue": {
"type": "string",
"example": "213457",
"description": "Applicable only when the `lineKeyType` is `SPEED_DIAL`. Value must be a valid telephone number, ext, or SIP URI (format: `user@host` using A-Z,a-z,0-9,-_ .+ for `user` and `host`)."
},
"sharedLineIndex": {
"type": "number",
"example": 4,
"description": "Shared line index is the line label number of the shared or virtual line assigned in the configured lines. Since you can add multiple appearances of the same shared or virtual line on a phone, entering the index number assigns the respective line to a line key. This is applicable only when the `lineKeyType` is SHARED_LINE. `sharedLineIndex` starts at 1 and increments by one for each shared line."
}
}
},
"LayoutMode": {
"type": "string",
"enum": [
"DEFAULT",
"CUSTOM"
],
"description": " * `DEFAULT` - Default layout mode when a new device is added.\n * `CUSTOM` - Enables a device to have its custom layout.\n"
},
"RebuildPhonesPostRequest": {
"type": "object",
"required": [
"locationId"
],
"properties": {
"locationId": {
"type": "string",
"description": "Unique identifier of the location."
}
}
},
"RebuildPhonesList": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RebuildPhonesJob"
},
"description": "List of rebuild phones jobs."
}
}
},
"RebuildPhonesJob": {
"type": "object",
"required": [
"name",
"id",
"trackingId",
"sourceUserId",
"sourceCustomerId",
"targetCustomerId",
"instanceId",
"latestExecutionStatus",
"target",
"percentageComplete"
],
"properties": {
"name": {
"type": "string",
"example": "rebuildphones",
"description": "Name of the job which in this case, is `rebuildphones`."
},
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wNjZkOTQzNC1kODEyLTQzODItODVhMC00MjBlOTFlODg3ZTY",
"description": "Unique identifier of the job."
},
"trackingId": {
"type": "string",
"example": "ROUTERGW_1d458245-ee34-48c8-8ed6-92ea16ed48aa",
"description": "Unique identifier to track the flow of HTTP requests."
},
"sourceUserId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81MDRhZmQ1YS0zODRiLTQ0NjYtYTJlNC05Y2ExZjUwMDRlYWQ",
"description": "Unique identifier of the user who has run the job."
},
"sourceCustomerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
"description": "Unique identifier of the customer who has run the job."
},
"targetCustomerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
"description": "Unique identifier of the customer for which the job was run."
},
"instanceId": {
"type": "number",
"example": 428989,
"description": "Unique identifier to identify the instance of the job."
},
"jobExecutionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobExecutionStatusObject"
},
"description": "Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job."
},
"latestExecutionStatus": {
"$ref": "#/components/schemas/LatestExecutionStatus",
"description": "Indicates the most recent status of the job at the time of invocation."
},
"latestExecutionExitCode": {
"type": "string",
"enum": [
"UNKNOWN",
"COMPLETED",
"FAILED",
"STOPPED",
"COMPLETED_WITH_ERRORS"
],
"description": "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n"
},
"target": {
"type": "string",
"example": "LOCATION",
"description": "Indicates the target entity, i.e. LOCATION."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzQ0Y2UwNDBhLTEzNmMtNDc3NS1hMjIzLTY5OTczYmEyYWNhYw",
"description": "Unique identifier of a location."
},
"percentageComplete": {
"type": "integer",
"example": 10,
"description": "Indicates the progress of the job."
},
"deviceCount": {
"type": "number",
"example": 10,
"description": "Count of number of devices rebuilt."
}
}
},
"EnhancedMulticastObject": {
"type": "object",
"required": [
"multicastList"
],
"properties": {
"xmlAppUrl": {
"type": "string",
"example": "http://127.0.0.1:8080/",
"description": "Specify the URL for the XML application."
},
"multicastList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MulticastObject"
},
"description": "Specify up to 10 multicast group URLs each with a unique listening port, an XML application URL, and a timeout."
}
}
},
"MulticastObject": {
"type": "object",
"required": [
"hostAndPort",
"hasXmlAppUrl"
],
"properties": {
"hostAndPort": {
"type": "string",
"example": "224.0.0.0:22",
"description": "Specify the multicast group URL and listening port."
},
"hasXmlAppUrl": {
"type": "boolean",
"example": true,
"description": "Specify whether the multicast group URL has an XML application URL."
},
"xmlAppTimeout": {
"type": "number",
"example": 10,
"description": "Specify the timeout for the XML application."
}
}
},
"listBackgroundImagesObject": {
"type": "object",
"required": [
"backgroundImageUrl",
"fileName"
],
"properties": {
"backgroundImageUrl": {
"type": "string",
"example": "\"/dms/Cisco_Phone_Background/background001\"",
"description": "The URL of the image file."
},
"fileName": {
"type": "string",
"example": "CompanyLogoBlue",
"description": "The name of the image file."
}
}
},
"deleteImageResponseObject": {
"type": "object",
"required": [
"fileName",
"result"
],
"properties": {
"fileName": {
"type": "string",
"example": "CompanyLogoBlue",
"description": "The name of the image file."
},
"result": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "number",
"example": 400,
"description": "The status of the deletion."
},
"error": {
"type": "object",
"required": [
"message",
"errorCode"
],
"properties": {
"message": {
"type": "string",
"example": "The image could not be deleted.",
"description": "The error message."
},
"errorCode": {
"type": "number",
"example": 4305,
"description": "The error code."
}
},
"description": "The error message if the deletion failed."
}
},
"description": "The result of the deletion."
}
}
},
"deleteImageResponseSuccessObject": {
"type": "object",
"required": [
"fileName",
"result"
],
"properties": {
"fileName": {
"type": "string",
"example": "CompanyLogoBlue",
"description": "The name of the image file."
},
"result": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "number",
"example": 200,
"description": "The status of the deletion."
}
},
"description": "The result of the deletion."
}
}
},
"deleteImageRequestObject": {
"type": "object",
"required": [
"fileName"
],
"properties": {
"fileName": {
"type": "string",
"example": "CompanyLogoBlue",
"description": "The name of the image file to be deleted."
},
"forceDelete": {
"type": "boolean",
"example": true,
"description": "Flag to force delete the image. When `forceDelete` = true, if any device, location, or org level custom background URL is configured with the `backgroundImageURL` containing the filename being deleted, the background image is set to `None`."
}
}
},
"userDeviceCount": {
"type": "object",
"required": [
"totalDeviceCount",
"applicationsCount"
],
"properties": {
"totalDeviceCount": {
"type": "number",
"example": 3,
"description": "The total count of devices associated with the user as a sum of:\n\n- Count of total primary physical devices.\n\n- Count of Webex-Team system device endpoints.\n\n- Count of 1 for any or all applications present."
},
"applicationsCount": {
"type": "number",
"example": 4,
"description": "The total count of applications associated with the user."
}
}
},
"DeviceDynamicSettingsValidationSchemaGet": {
"type": "object",
"example": {
"tags": [
{
"familyOrModelDisplayName": "Poly",
"tag": "%G711U_ORDER%",
"friendlyName": "voice.codecPref.G711Mu",
"tooltip": "Tag tooltip.",
"level": [
"location",
"device"
],
"validationRule": {
"type": "int",
"min": 0,
"max": 10,
"increment": 1
}
}
]
},
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceTag"
},
"description": "Array of device settings tags with their validation rules."
}
}
},
"DeviceDynamicSettingsSettingsGroupsGet": {
"type": "object",
"example": {
"settingsGroups": [
{
"path": "Voice.Codec Preferences",
"friendlyName": "voice.codecPref.G711Mu",
"tab": "Poly",
"familyOrModelDisplayName": "Poly",
"tags": [
{
"tagBlock": [
"%G711U_ORDER%"
]
}
]
}
],
"settingsTabs": [
"Poly",
"MPP"
]
},
"properties": {
"settingsGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceSettingsGroup"
},
"description": "Array of settings groups defining structure and association of tags."
},
"settingsTabs": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of settings tabs names. Can be filtered using the `includeSettingsType` parameter."
}
}
},
"DeviceTag": {
"type": "object",
"properties": {
"familyOrModelDisplayName": {
"type": "string",
"description": "The family or model name of the device to which these settings apply.",
"example": "Poly"
},
"tag": {
"type": "string",
"description": "The unique identifier for the setting.",
"example": "%G711U_ORDER%"
},
"friendlyName": {
"type": "string",
"description": "A user-friendly name for the setting. It helps to correlate the tag with the UI in settings groups.",
"example": "voice.codecPref.G711Mu"
},
"tooltip": {
"type": "string",
"description": "Explanatory text for the setting.",
"example": "Tag tooltip."
},
"alert": {
"type": "string",
"description": "Alert message related to this setting, if applicable.",
"example": "Alert text."
},
"level": {
"type": "array",
"items": {
"type": "string"
},
"description": "The levels at which this setting can be configured. When fetching tags or updating tags, the tag should be allowed at the level the request is made for.",
"example": [
"organization",
"location",
"device"
]
},
"validationRule": {
"$ref": "#/components/schemas/ValidationRule"
}
}
},
"DeviceSettingsGroup": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Path of the settings group. Creates an easily navigable settings hierarchy.",
"example": "Voice.Codec Preferences"
},
"friendlyName": {
"type": "string",
"description": "Friendly name of the settings group.",
"example": "voice.codecPref.G711Mu"
},
"tab": {
"type": "string",
"description": "Tab name associated with the settings group.",
"example": "Poly"
},
"familyOrModelDisplayName": {
"type": "string",
"description": "Family or model display name associated with the settings group.",
"example": "Poly"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceSettingsGroupTag"
},
"description": "List of `tagBlock` objects associated with the settings group."
}
}
},
"DeviceSettingsGroupTag": {
"type": "object",
"properties": {
"tagBlock": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of tags associated with the settings group.",
"example": [
"%G711U_ORDER%"
]
}
}
},
"ValidationRule": {
"type": "object",
"description": "Validation rules and constraints for device setting values.",
"properties": {
"type": {
"type": "string",
"description": "The data type of the setting. Possible values are `string`, `integer`, `boolean`, `enum` , `password` or `network`.",
"example": "\"int\""
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "Possible values for `enum` or `boolean` types.",
"example": [
"0",
"1",
"2",
"NumberOnly"
]
},
"min": {
"type": "integer",
"description": "Minimum value for numeric types.",
"example": 0
},
"max": {
"type": "integer",
"description": "Maximum value for numeric types.",
"example": 10
},
"increment": {
"type": "integer",
"description": "Increment value for numeric types.",
"example": 1
},
"regex": {
"type": "string",
"description": "Regular expression pattern for string validation.",
"example": "[A-Za-z0-9]+"
},
"maxLength": {
"type": "integer",
"description": "Maximum length for string values.",
"example": 255
},
"validationHint": {
"type": "string",
"description": "Hint to display to users about validation requirements.",
"example": "5-60"
}
}
},
"CustomerDeviceDynamicSettingsListPostRequest": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"description": "Optional array of device tag identifiers to request settings for. Each identifier must have a length between 1 and 64 characters.",
"minItems": 0
}
}
},
"CustomerDeviceDynamicSettingsListPostResponse": {
"type": "object",
"example": {
"tags": [
{
"familyOrModelDisplayName": "Poly",
"tag": "%DO_MENU_ITEM_BACKGROUND%",
"value": "#RRGGBB",
"parentValue": "#FFFFFF",
"parentLevel": "ORGANIZATION"
}
],
"lastUpdateTime": 1651396800000,
"updateInProgress": false
},
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerDevicePostTag"
},
"description": "Array of device setting values matching the requested tags."
},
"lastUpdateTime": {
"type": "integer",
"format": "int64",
"description": "Timestamp of the last update to these settings."
},
"updateInProgress": {
"type": "boolean",
"description": "Flag indicating if an update to these settings is currently in progress."
}
}
},
"CustomerDevicePostTag": {
"type": "object",
"properties": {
"familyOrModelDisplayName": {
"type": "string",
"description": "The `familyOrModelDisplayName` of the device.",
"example": "Poly"
},
"tag": {
"type": "string",
"description": "The unique identifier for the setting.",
"example": "%G711U_ORDER%"
},
"value": {
"type": "string",
"description": "The current value of the setting at `ORGANIZATION` level. If the tag value is not set at the `ORGANIZATION` level, this field will not be included in the response.",
"example": "4"
},
"parentValue": {
"type": "string",
"description": "The value inherited from the immediate parent level above `ORGANIZATION`. It can be `SYSTEM_DEFAULT`, `REGIONAL_DEFAULT`, or `ORGANIZATION`, depending on which level the setting is actually configured at. If there is no parent level for this tag, this field will not be included in the response.",
"example": "3"
},
"parentLevel": {
"$ref": "#/components/schemas/DynamicDeviceSettingsCustomerParentLevel"
}
}
},
"DynamicDeviceSettingsCustomerParentLevel": {
"type": "string",
"enum": [
"SYSTEM_DEFAULT",
"REGIONAL_DEFAULT",
"ORGANIZATION"
],
"description": "The level from which the tag's parent value is inherited. If there is no parent level for this tag, this field will not be included in the response."
},
"LocationDeviceDynamicSettingsListPostRequest": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"description": "Optional array of device tag identifiers to request settings for. Each identifier must have a length between 1 and 64 characters.",
"minItems": 0
}
}
},
"LocationDeviceDynamicSettingsListPostResponse": {
"type": "object",
"example": {
"tags": [
{
"familyOrModelDisplayName": "Poly",
"tag": "%G711U_ORDER%",
"value": "4",
"parentValue": "3",
"parentLevel": "ORGANIZATION"
}
],
"lastUpdateTime": 1651396800000,
"updateInProgress": false
},
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LocationDevicePostResponseTag"
},
"description": "Array of device setting values matching the requested tags."
},
"lastUpdateTime": {
"type": "integer",
"format": "int64",
"description": "Timestamp of the last update to these settings."
},
"updateInProgress": {
"type": "boolean",
"description": "Flag indicating if an update to these settings is currently in progress."
}
}
},
"LocationDevicePostResponseTag": {
"type": "object",
"properties": {
"familyOrModelDisplayName": {
"type": "string",
"description": "The `familyOrModelDisplayName` of the device.",
"example": "Poly"
},
"tag": {
"type": "string",
"description": "The unique identifier for the setting.",
"example": "%G711U_ORDER%"
},
"value": {
"type": "string",
"description": "The current value of the setting at `LOCATION` level. If the tag value is not set at the `LOCATION` level, this field will not be included in the response.",
"example": "4"
},
"parentValue": {
"type": "string",
"description": "The value inherited from the immediate parent level above `LOCATION`. It can be `SYSTEM_DEFAULT`, `REGIONAL_DEFAULT`, `ORGANIZATION`, or `LOCATION`, depending on which level the setting is actually configured at. If there is no parent level for this tag, this field will not be included in the response.",
"example": "3"
},
"parentLevel": {
"$ref": "#/components/schemas/LocationParentLevel"
}
}
},
"LocationParentLevel": {
"type": "string",
"enum": [
"SYSTEM_DEFAULT",
"REGIONAL_DEFAULT",
"ORGANIZATION",
"LOCATION"
],
"description": "The level from which the tag's parent value is inherited. If there is no parent level for this tag, this field will not be included in the response."
},
"DeviceDynamicSettingsListPostRequest": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional array of tag identifiers representing specific settings to fetch. If omitted or provided as an empty array, all settings for the device will be returned.",
"minItems": 0
}
}
},
"DeviceDynamicSettingsListPostResponse": {
"type": "object",
"required": [
"tags"
],
"example": {
"tags": [
{
"familyOrModelDisplayName": "Poly",
"tag": "%G711U_ORDER%",
"value": "4",
"parentValue": "3",
"parentLevel": "ORGANIZATION"
}
],
"lastUpdateTime": 1651396800000
},
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DevicePostResponseTag"
},
"description": "Array of device setting values matching the requested tags."
},
"lastUpdateTime": {
"type": "integer",
"format": "int64",
"description": "Timestamp of the last update to these settings."
}
}
},
"DeviceDynamicSettingsPutRequest": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DevicePutItem"
},
"description": "Optional array of `tag` identifiers representing specific settings to update. If omitted or provided as an empty array, the request will have no effect.",
"minItems": 0
}
}
},
"DevicePostResponseTag": {
"type": "object",
"required": [
"familyOrModelDisplayName",
"tag"
],
"properties": {
"familyOrModelDisplayName": {
"type": "string",
"description": "The display name of the device family or model associated with the returned tag.",
"example": "Poly"
},
"tag": {
"type": "string",
"description": "The unique identifier for the device setting.",
"example": "%G711U_ORDER%"
},
"value": {
"type": "string",
"description": "The current value of the setting at device level. If the tag value is not set at the device level, this field will not be included in the response.",
"example": "4"
},
"parentValue": {
"type": "string",
"description": "The setting value at the next available `parentLevel`. It is used if `value` is not set and is omitted when no parent level exists for the tag.",
"example": "3"
},
"parentLevel": {
"$ref": "#/components/schemas/DeviceParentLevel"
}
}
},
"DeviceParentLevel": {
"type": "string",
"enum": [
"SYSTEM_DEFAULT",
"REGIONAL_DEFAULT",
"ORGANIZATION",
"LOCATION"
],
"description": "The level from which the tag's parent value is inherited. If there is no parent level for this tag, this field will not be included in the response."
},
"DevicePutItem": {
"type": "object",
"required": [
"tag",
"action"
],
"properties": {
"tag": {
"type": "string",
"description": "The unique identifier for the setting to be updated.",
"example": "%G711U_ORDER%",
"minLength": 1,
"maxLength": 64
},
"action": {
"$ref": "#/components/schemas/Action"
},
"value": {
"type": "string",
"description": "The new value to set for the setting. This field is required when `action` is `SET` and ignored otherwise.",
"example": "4",
"minLength": 1,
"maxLength": 256
}
}
},
"Action": {
"type": "string",
"enum": [
"SET",
"CLEAR"
],
"description": "The action to perform on the setting. When action is `SET`, `tag` is updated to specified value. When action is `CLEAR`, the `tag` value at device level is removed, and the device will inherit the value from the parent level, if it exists.",
"example": "SET"
},
"PostDynamicDeviceSettingsJobResponse": {
"type": "object",
"required": [
"name",
"id",
"trackingId",
"sourceUserId",
"sourceCustomerId",
"targetCustomerId",
"instanceId",
"jobExecutionStatus",
"latestExecutionStatus",
"latestExecutionExitCode",
"target",
"percentageComplete"
],
"example": {
"name": "dynamicdevicesettings",
"id": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wNjZkOTQzNC1kODEyLTQzODItODVhMC00MjBlOTFlODg3ZTY",
"trackingId": "ROUTERGW_1d458245-ee34-48c8-8ed6-92ea16ed48aa",
"sourceUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81MDRhZmQ1YS0zODRiLTQ0NjYtYTJlNC05Y2ExZjUwMDRlYWQ",
"sourceCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
"targetCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
"instanceId": 428989,
"jobExecutionStatus": [
{
"id": 0,
"startTime": "2025-05-13T10:59:44.106Z",
"lastUpdated": "2025-05-13T10:59:44.106Z",
"statusMessage": "STARTED",
"exitCode": "UNKNOWN",
"createdTime": "2025-05-13T10:50:01.352Z",
"timeElapsed": "PT11.476S"
}
],
"latestExecutionStatus": "STARTED",
"latestExecutionExitCode": "UNKNOWN",
"target": "CUSTOMER",
"locationId": "",
"percentageComplete": 100
},
"properties": {
"name": {
"type": "string",
"example": "dynamicdevicesettings",
"description": "Name of the job which in this case, is `dynamicdevicesettings`."
},
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wNjZkOTQzNC1kODEyLTQzODItODVhMC00MjBlOTFlODg3ZTY",
"description": "Unique identifier of the job."
},
"trackingId": {
"type": "string",
"example": "ROUTERGW_1d458245-ee34-48c8-8ed6-92ea16ed48aa",
"description": "Unique identifier to track the flow of HTTP requests."
},
"sourceUserId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81MDRhZmQ1YS0zODRiLTQ0NjYtYTJlNC05Y2ExZjUwMDRlYWQ",
"description": "Unique identifier of the user who has run the job."
},
"sourceCustomerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
"description": "Unique identifier of the customer who has run the job."
},
"targetCustomerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
"description": "Unique identifier of the customer for which the job was run."
},
"instanceId": {
"type": "number",
"example": 428989,
"description": "Unique identifier to identify the instance of the job."
},
"jobExecutionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobExecutionStatusObject"
},
"description": "Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job."
},
"latestExecutionStatus": {
"$ref": "#/components/schemas/LatestExecutionStatus"
},
"latestExecutionExitCode": {
"type": "string",
"enum": [
"UNKNOWN",
"COMPLETED",
"FAILED",
"STOPPED",
"COMPLETED_WITH_ERRORS"
],
"description": "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n"
},
"target": {
"type": "string",
"enum": [
"CUSTOMER",
"LOCATION"
],
"example": "LOCATION",
"description": "Indicates the target entity."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzQ0Y2UwNDBhLTEzNmMtNDc3NS1hMjIzLTY5OTczYmEyYWNhYw",
"description": "Unique identifier of a location."
},
"locationName": {
"type": "string",
"example": "Brampton",
"description": "Name of the location. Included only when `target` is `LOCATION`."
},
"percentageComplete": {
"type": "integer",
"example": 10,
"description": "Indicates the progress of the job."
}
}
},
"LatestExecutionStatus": {
"type": "string",
"enum": [
"STARTING",
"STARTED",
"COMPLETED",
"FAILED"
],
"description": " * `STARTING` - Indicates the job has started.\n * `STARTED` - Indicates the job is in progress.\n * `COMPLETED` - Indicates the job has completed.\n * `FAILED` - Indicates the job has failed.\n"
},
"JobExecutionStatusObject": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"example": 436272,
"description": "Unique identifier that identifies each instance of the job."
},
"startTime": {
"type": "string",
"example": "2025-05-13T10:59:44.106Z",
"description": "Step execution start time in UTC format."
},
"endTime": {
"type": "string",
"example": "2025-05-13T10:59:44.692Z",
"description": "Step execution end time in UTC format."
},
"lastUpdated": {
"type": "string",
"example": "2025-05-13T10:59:44.854Z",
"description": "Last updated time (in UTC format) post one of the step execution completion."
},
"statusMessage": {
"type": "string",
"example": "STARTING",
"description": "Displays status for overall steps that are part of the job."
},
"exitCode": {
"type": "string",
"example": "UNKNOWN",
"description": "Exit Code for a job."
},
"createdTime": {
"type": "string",
"example": "2024-03-13T14:57:04.678Z",
"description": "Job creation time in UTC format."
},
"timeElapsed": {
"type": "string",
"example": "PT0S",
"description": "Time lapsed since the job execution started."
},
"stepExecutionStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/stepExecutionStatusesObject"
},
"description": "Status of each step within a job."
}
}
},
"JobExecutionStatusObject1": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Unique identifier that identifies each instance of the job."
},
"lastUpdated": {
"type": "string",
"description": "Last updated time (in UTC format) post one of the step execution completion."
},
"statusMessage": {
"type": "string",
"description": "Displays status for overall steps that are part of the job."
},
"exitCode": {
"type": "string",
"description": "Exit Code for a job."
},
"createdTime": {
"type": "string",
"description": "Job creation time in UTC format."
},
"timeElapsed": {
"type": "string",
"description": "Time lapsed since the job execution started."
}
}
},
"stepExecutionStatusesObject": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"example": 1998857,
"description": "Unique identifier that identifies each step in a job."
},
"startTime": {
"type": "string",
"example": "2024-03-13T03:58:36.886Z",
"description": "Step execution start time in UTC format."
},
"endTime": {
"type": "string",
"example": "2024-03-13T03:58:48.471Z",
"description": "Step execution end time in UTC format."
},
"lastUpdated": {
"type": "string",
"example": "2024-03-13T03:58:48.472Z",
"description": "Last updated time for a step in UTC format."
},
"statusMessage": {
"type": "string",
"example": "COMPLETED",
"description": "Displays the status of a step."
},
"exitCode": {
"type": "string",
"example": "COMPLETED",
"description": "Exit Code for a step."
},
"name": {
"type": "string",
"example": "dynamicdevicesettingsUpdate",
"description": "Name of different steps the job goes through."
},
"timeElapsed": {
"type": "string",
"example": "PT11.585S",
"description": "Time lapsed since the step execution started."
}
}
},
"PostDynamicSettingsUpdateStartJobRequest": {
"type": "object",
"required": [
"tags"
],
"properties": {
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"description": "If present, the requested settings will be updated to devices under this location."
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DynamicSettingsUpdateJobDevicePostItem"
},
"description": "Array of tag identifiers for settings to be updated. Each setting is identified by a `familyOrModelDisplayName` and `tag`. Supports updating multiple settings across different device families in a single request.",
"minItems": 1
}
}
},
"DynamicSettingsUpdateJobDevicePostItem": {
"type": "object",
"required": [
"familyOrModelDisplayName",
"tag",
"action"
],
"properties": {
"familyOrModelDisplayName": {
"type": "string",
"description": "The `familyOrModelDisplayName` of the device to which the tag applies. This value must exist in the validation schema.",
"example": "Poly",
"minLength": 1,
"maxLength": 40
},
"tag": {
"type": "string",
"description": "The unique identifier for the setting to be updated.",
"example": "%G711U_ORDER%",
"minLength": 1,
"maxLength": 64
},
"action": {
"$ref": "#/components/schemas/Action"
},
"value": {
"type": "string",
"description": "The new value to set for the setting. This field is required when `action` is `SET` and ignored otherwise.",
"example": "4",
"minLength": 1,
"maxLength": 256
}
}
},
"DynamicDeviceSettingsJobListResponse": {
"type": "object",
"required": [
"items"
],
"example": {
"items": [
{
"name": "dynamicdevicesettings",
"id": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wZTJjNmI5NC1hNDdlLTQxZGUtODE5ZS04YTcwNTZjMTc5MDk",
"trackingId": "NA_a9ef6908-60cf-40e6-b56f-461abffd6fa3",
"sourceUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"sourceCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M",
"targetCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M",
"instanceId": 0,
"jobExecutionStatus": [],
"latestExecutionStatus": "COMPLETED",
"latestExecutionExitCode": "COMPLETED",
"target": "LOCATION",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgwZmUxMzdkLTg5NDgtNDlhYS1iODdiLTk4MGMxN2I2YzdiYg",
"percentageComplete": 100
}
]
},
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostDynamicDeviceSettingsJobResponse"
},
"description": "Lists all jobs for the customer of type `dynamicdevicesettings` in order of most recent one to oldest one irrespective of its status."
}
}
},
"ErrorResponseObject": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemObject"
}
}
}
},
"ItemObject": {
"type": "object",
"properties": {
"itemNumber": {
"type": "number",
"description": "Index of error."
},
"trackingId": {
"type": "string",
"description": "Unique identifier to track the HTTP request."
},
"error": {
"$ref": "#/components/schemas/ErrorObject",
"description": "Error details."
}
}
},
"ErrorObject": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "HTTP status code."
},
"message": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorMessageObject"
},
"description": "List of error messages."
}
}
},
"ErrorMessageObject": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Error message."
},
"code": {
"type": "string",
"description": "Internal error code."
},
"locationId": {
"type": "string",
"description": "Not used."
}
}
},
"supportedDevicesObject": {
"type": "object",
"required": [
"devices",
"upgradeChannelList"
],
"example": {
"upgradeChannelList": [
"STABLE",
"STABLE_DELAY",
"PREVIEW",
"BETA",
"TESTING"
],
"devices": [
{
"model": "2N Customer Managed",
"displayName": "2N Customer Managed",
"type": "GENERIC_SIP",
"manufacturer": "THIRD_PARTY",
"managedBy": "CUSTOMER",
"supportedFor": [
"PEOPLE",
"PLACE"
],
"onboardingMethod": [
"MAC_ADDRESS"
],
"allowConfigureLayoutEnabled": false,
"numberOfLinePorts": 20,
"kemSupportEnabled": true,
"kemModuleCount": 1,
"kemLinesSupportEnabled": false,
"kemModuleType": [
"KEM_20_KEYS"
],
"upgradeChannelEnabled": false,
"additionalPrimaryLineAppearancesEnabled": false,
"basicEmergencyNomadicEnabled": false,
"customizedBehaviorsEnabled": false,
"allowConfigurePortsEnabled": false,
"customizableLineLabelEnabled": false,
"supportsLinePortReorderingEnabled": false,
"portNumberSupportEnabled": false,
"t38Enabled": false,
"callDeclinedEnabled": false,
"touchScreenPhone": false,
"numberOfLineKeyButtons": 0,
"deviceSettingsConfiguration": "NONE",
"allowHotelingHostEnabled": false,
"supportsLogCollection": "NONE",
"supportsApplyChangesEnabled": false,
"allowConfigureLinesEnabled": true,
"allowConfigurePhoneSettingsEnabled": false,
"supportsHotlineEnabled": false
},
{
"model": "DMS Polycom EE400",
"displayName": "Polycom EE400",
"familyDisplayName": "Poly",
"type": "GENERIC_SIP",
"manufacturer": "THIRD_PARTY",
"managedBy": "CISCO",
"supportedFor": [
"PEOPLE",
"PLACE"
],
"onboardingMethod": [
"MAC_ADDRESS"
],
"allowConfigureLayoutEnabled": false,
"numberOfLinePorts": 14,
"kemSupportEnabled": false,
"kemLinesSupportEnabled": false,
"upgradeChannelEnabled": false,
"additionalPrimaryLineAppearancesEnabled": true,
"basicEmergencyNomadicEnabled": false,
"customizedBehaviorsEnabled": true,
"allowConfigurePortsEnabled": false,
"customizableLineLabelEnabled": false,
"supportsLinePortReorderingEnabled": true,
"portNumberSupportEnabled": false,
"t38Enabled": false,
"callDeclinedEnabled": true,
"touchScreenPhone": false,
"numberOfLineKeyButtons": 0,
"deviceSettingsConfiguration": "WEBEX_CALLING_DYNAMIC_DEVICE_CONFIGURATION",
"allowHotelingHostEnabled": true,
"supportsLogCollection": "NONE",
"supportsApplyChangesEnabled": true,
"allowConfigureLinesEnabled": true,
"allowConfigurePhoneSettingsEnabled": true,
"supportsHotlineEnabled": true
}
]
},
"properties": {
"upgradeChannelList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpgradeChannelObject"
},
"description": "List of available upgrade channels.\n * `STABLE` - These are standard stable releases.\n * `STABLE_DELAY` - These are delayed stable releases.\n * `PREVIEW` - These are Preview/pre-release versions.\n * `BETA` - These are Beta testing versions.\n * `TESTING` - These are testing versions.\n"
},
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceObject"
},
"description": "List of supported devices."
}
}
},
"UpgradeChannelObject": {
"type": "string",
"enum": [
"STABLE",
"STABLE_DELAY",
"PREVIEW",
"BETA",
"TESTING"
]
},
"DeviceObject": {
"type": "object",
"required": [
"model",
"displayName",
"type",
"manufacturer",
"managedBy",
"supportedFor",
"onboardingMethod",
"allowConfigureLayoutEnabled",
"numberOfLinePorts",
"kemSupportEnabled",
"kemLinesSupportEnabled",
"upgradeChannelEnabled",
"additionalPrimaryLineAppearancesEnabled",
"basicEmergencyNomadicEnabled",
"customizedBehaviorsEnabled",
"allowConfigurePortsEnabled",
"customizableLineLabelEnabled",
"supportsLinePortReorderingEnabled",
"portNumberSupportEnabled",
"t38Enabled",
"callDeclinedEnabled",
"touchScreenPhone",
"numberOfLineKeyButtons",
"allowHotelingHostEnabled",
"supportsApplyChangesEnabled",
"allowConfigureLinesEnabled",
"allowConfigurePhoneSettingsEnabled",
"supportsHotlineEnabled"
],
"properties": {
"model": {
"type": "string",
"example": "2N Customer Managed",
"description": "Model name of the device."
},
"displayName": {
"type": "string",
"example": "2N Customer Managed",
"description": "Display name of the device."
},
"familyDisplayName": {
"type": "string",
"example": "Poly",
"description": "The display name of the device family."
},
"type": {
"$ref": "#/components/schemas/TypeObject"
},
"manufacturer": {
"$ref": "#/components/schemas/ManufacturerObject"
},
"managedBy": {
"$ref": "#/components/schemas/ManagedByObject"
},
"supportedFor": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SupportedForObject"
},
"description": "List of places the device is supported for."
},
"onboardingMethod": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OnboardingMethodObject"
},
"description": "Onboarding method."
},
"allowConfigureLayoutEnabled": {
"type": "boolean",
"description": "Enables / Disables layout configuration for devices."
},
"numberOfLinePorts": {
"type": "number",
"description": "Number of port lines."
},
"kemSupportEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether Kem support is enabled or not."
},
"kemModuleCount": {
"type": "number",
"description": "Module count."
},
"kemLinesSupportEnabled": {
"type": "boolean",
"description": "Enables / disables Kem lines support."
},
"kemModuleType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/KemModuleType"
},
"description": "Key expansion module type of the device."
},
"upgradeChannelEnabled": {
"type": "boolean",
"description": "Enables / Disables the upgrade channel."
},
"defaultUpgradeChannel": {
"type": "string",
"description": "The default upgrade channel."
},
"additionalPrimaryLineAppearancesEnabled": {
"type": "boolean",
"description": "Enables / disables the additional primary line appearances."
},
"basicEmergencyNomadicEnabled": {
"type": "boolean",
"description": "Enables / disables Basic emergency nomadic."
},
"customizedBehaviorsEnabled": {
"type": "boolean",
"description": "Enables / disables customized behavior support on devices."
},
"allowConfigurePortsEnabled": {
"type": "boolean",
"description": "Enables / disables configuring port support on device."
},
"customizableLineLabelEnabled": {
"type": "boolean",
"description": "Enables / disables customizable line label."
},
"supportsLinePortReorderingEnabled": {
"type": "boolean",
"description": "Enables / disables support line port reordering."
},
"portNumberSupportEnabled": {
"type": "boolean",
"description": "Enables / disables port number support."
},
"t38Enabled": {
"type": "boolean",
"description": "Enables / disables T.38."
},
"callDeclinedEnabled": {
"type": "boolean",
"description": "Enables / disables call declined."
},
"touchScreenPhone": {
"type": "boolean",
"description": "Supports touch screen on device."
},
"numberOfLineKeyButtons": {
"type": "number",
"description": "Number of line key buttons for a device."
},
"deviceSettingsConfiguration": {
"$ref": "#/components/schemas/DeviceSettingsConfigurationObject"
},
"allowHotelingHostEnabled": {
"type": "boolean",
"description": "Enables / disables hoteling host."
},
"supportsLogCollection": {
"$ref": "#/components/schemas/SupportsLogCollectionObject"
},
"supportsApplyChangesEnabled": {
"type": "boolean",
"description": "Enables / disables apply changes."
},
"allowConfigureLinesEnabled": {
"type": "boolean",
"description": "Enables / disables configure lines."
},
"allowConfigurePhoneSettingsEnabled": {
"type": "boolean",
"description": "Enables / disables configure phone settings."
},
"supportsHotlineEnabled": {
"type": "boolean",
"description": "Enables / disables hotline support."
},
"maxNumberOfLineAppearances": {
"type": "number",
"description": "Maximum number of line appearances available on the device."
}
}
},
"TypeObject": {
"type": "string",
"enum": [
"MPP",
"ATA",
"GENERIC_SIP",
"ESIM",
"DESK_PHONE"
],
"description": " * `MPP` - Cisco Multiplatform Phone\n * `ATA` - Analog Telephone Adapters\n * `GENERIC_SIP` - GENERIC Session Initiation Protocol\n * `ESIM` - Esim Supported Webex Go\n * `DESK_PHONE` - Desk Phone\n"
},
"ManagedByObject": {
"type": "object",
"properties": {
"orgId": {
"type": "string",
"example": "d1349664-9f3d-410b-8bd3-6c31f181f14e",
"description": "The Organization identifier of the resource."
},
"type": {
"type": "string",
"example": "user",
"description": "The resource type."
},
"id": {
"type": "string",
"example": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
"description": "The identifier of the resource."
},
"role": {
"type": "string",
"example": "location_full_admin",
"description": "The delegated role."
}
}
},
"ManufacturerObject": {
"type": "string",
"enum": [
"CISCO",
"THIRD_PARTY"
],
"description": " * `CISCO` - Devices manufactured by Cisco.\n * `THIRD_PARTY` - Devices manufactured by a third-party that are approved by a Cisco account manager to be enabled for provisioning in the control hub.\n"
},
"SupportedForObject": {
"type": "string",
"enum": [
"PEOPLE",
"PLACE"
]
},
"OnboardingMethodObject": {
"type": "string",
"enum": [
"MAC_ADDRESS",
"ACTIVATION_CODE",
"NONE"
]
},
"SupportsLogCollectionObject": {
"type": "string",
"enum": [
"NONE",
"CISCO_PRT",
"CISCO_ROOMOS"
],
"description": " * `NONE` - Devices which does not support log collection.\n * `CISCO_PRT` - Devices which supports Cisco PRT log collection.\n * `CISCO_ROOMOS` - Devices which supports Cisco RoomOS log collection.\n"
},
"DeviceSettingsConfigurationObject": {
"type": "string",
"enum": [
"WEBEX_CALLING_DEVICE_CONFIGURATION",
"WEBEX_DEVICE_CONFIGURATION",
"WEBEX_CALLING_DYNAMIC_DEVICE_CONFIGURATION",
"NONE"
],
"description": " * `WEBEX_CALLING_DEVICE_CONFIGURATION` - Devices which supports Webex Calling Device Settings Configuration.\n * `WEBEX_DEVICE_CONFIGURATION` - Devices which supports Webex Device Settings Configuration.\n * `WEBEX_CALLING_DYNAMIC_DEVICE_CONFIGURATION` - Devices which supports Webex Calling dynamic Settings Configuration.\n * `NONE` - Devices does not support any configuration.\n"
},
"KemModuleType": {
"type": "string",
"enum": [
"KEM_14_KEYS",
"KEM_18_KEYS",
"KEM_20_KEYS"
],
"description": " * `KEM_14_KEYS` - Extension module has 14 line keys that can be configured.\n * `KEM_18_KEYS` - Extension module has 18 line keys that can be configured.\n * `KEM_20_KEYS` - Extension module has 20 line keys that can be configured.\n"
},
"ActivationCode": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "5414011256173816",
"description": "The activation code."
},
"expiryTime": {
"type": "string",
"example": "2017-11-16T23:38:03.215Z",
"description": "The date and time the activation code expires."
}
}
},
"Device": {
"type": "object",
"required": [
"created"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3",
"description": "A unique identifier for the device."
},
"displayName": {
"type": "string",
"example": "SFO12-3-PanHandle",
"description": "A friendly name for the device."
},
"placeId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
"description": "The `placeId` field has been deprecated. Please use `workspaceId` instead."
},
"workspaceId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
"description": "The workspace associated with the device."
},
"personId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
"description": "The person associated with the device."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The organization associated with the device."
},
"capabilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceCapabilities"
},
"description": "The capabilities of the device.",
"example": [
"xapi"
]
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DevicePermissions"
},
"description": "The permissions the user has for this device. For example, `xapi` means this user is entitled to using the `xapi` against this device.",
"example": [
"xapi:readonly",
"xapi:all"
]
},
"connectionStatus": {
"$ref": "#/components/schemas/DeviceConnectionStatus"
},
"product": {
"type": "string",
"example": "Cisco Webex DX80",
"description": "The product name. A display friendly version of the device's `model`."
},
"type": {
"type": "string",
"example": "roomdesk",
"description": "The product type."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"example": "First Tag, Second Tag"
},
"description": "Tags assigned to the device.",
"example": [
"First Tag",
"Second Tag"
]
},
"ip": {
"type": "string",
"example": "100.110.120.130",
"description": "The current IP address of the device."
},
"activeInterface": {
"$ref": "#/components/schemas/NetworkConnectivityType"
},
"mac": {
"type": "string",
"example": "11:22:33:44:AA:FF",
"description": "The unique address for the network adapter."
},
"primarySipUrl": {
"type": "string",
"example": "sample_device@sample_workspacename.orgname.org",
"description": "The primary SIP address to dial this device."
},
"sipUrls": {
"example": [
"sample_device@sample_workspacename.orgname.org",
"another_device@sample_workspacename.orgname.org"
],
"type": "array",
"items": {
"type": "string",
"example": "sample_device@sample_workspacename.orgname.org, another_device@sample_workspacename.orgname.org"
},
"description": "All SIP addresses to dial this device."
},
"serial": {
"type": "string",
"example": "FOC1923NVVN",
"description": "Serial number for the device."
},
"software": {
"type": "string",
"example": "RoomOS 2018-06-01 608dcdbb6e1",
"description": "The operating system name data and version tag."
},
"upgradeChannel": {
"type": "string",
"example": "beta",
"description": "The upgrade channel the device is assigned to."
},
"created": {
"type": "string",
"example": "2016-04-21T17:00:00.000Z",
"description": "The date and time that the device was registered, in ISO8601 format."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The location associated with the device."
},
"workspaceLocationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The workspace location associated with the device. Deprecated, prefer `locationId`."
},
"errorCodes": {
"example": [
"sipprofileregistration"
],
"type": "array",
"items": {
"type": "string",
"example": "sipprofileregistration"
},
"description": "Error codes coming from the device."
},
"firstSeen": {
"type": "string",
"example": "2021-02-24T09:08:38.822Z",
"description": "Timestamp of the first time device sent a status post."
},
"lastSeen": {
"type": "string",
"example": "2023-08-15T14:04:00.444Z",
"description": "Timestamp of the last time device sent a status post."
},
"managedBy": {
"$ref": "#/components/schemas/ManagedBy"
},
"devicePlatform": {
"$ref": "#/components/schemas/DevicePlatform"
},
"plannedMaintenance": {
"type": "object",
"description": "The planned maintenance for the device.",
"properties": {
"mode": {
"type": "string",
"enum": [
"off",
"on",
"upcoming"
],
"description": "The planned maintenance mode for the device"
}
}
}
}
},
"DeviceCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Device"
}
}
}
},
"NetworkConnectivityType": {
"type": "string",
"enum": [
"wired"
],
"description": "The current network connectivity for the device.",
"example": "wired"
},
"DeviceConnectionStatus": {
"type": "string",
"enum": [
"connected",
"disconnected",
"connected_with_issues",
"offline_expired",
"activating",
"unknown",
"offline_deep_sleep"
],
"description": "The connection status of the device.",
"example": "connected"
},
"DevicePermissions": {
"type": "string",
"enum": [
"xapi:readonly",
"xapi:all"
]
},
"DeviceCapabilities": {
"type": "string",
"enum": [
"xapi"
]
},
"ManagedBy": {
"type": "object",
"properties": {
"orgId": {
"type": "string",
"description": "The admin’s organization ID. It represents either the partner organization that owns the customer group or an external administrator’s organization\n",
"example": "09ebb769-3098-4446-9093-4b39b296602b"
},
"type": {
"type": "string",
"description": "Type of administrator.",
"enum": [
"user"
],
"example": "user"
},
"id": {
"type": "string",
"description": "Entryuuid of the user.",
"example": "cb092233-b3e6-48fd-ab42-551f8cb01513"
},
"email": {
"type": "string",
"description": "Email of the user. Either Email or id is required in managedBy field",
"example": "user@example.com"
},
"roles": {
"type": "array",
"description": "The roles assigned to the admin for managing the customer group.",
"items": {
"type": "string"
}
}
}
},
"DevicePlatform": {
"type": "string",
"enum": [
"cisco",
"microsoftTeamsRoom"
],
"description": "Device platform",
"example": "cisco"
},
"MaintenanceMode": {
"type": "string",
"enum": [
"off",
"on",
"upcoming"
],
"example": "off",
"description": "The maintenance mode of the device."
},
"Event": {
"type": "object",
"required": [
"id",
"resource",
"type",
"actorId",
"orgId",
"created",
"data"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0VWRU5UL2JiY2ViMWFkLTQzZjEtM2I1OC05MTQ3LWYxNGJiMGM0ZDE1NAo",
"description": "The unique identifier for the event."
},
"resource": {
"$ref": "#/components/schemas/EventResourceEnum",
"description": "The type of resource in the event."
},
"type": {
"$ref": "#/components/schemas/EventTypeEnum",
"description": "The action which took place in the event."
},
"appId": {
"type": "string",
"example": "null",
"description": "The ID of the application for the event."
},
"actorId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"description": "The ID of the person who performed the action."
},
"orgId": {
"type": "string",
"example": "OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"description": "The ID of the organization for the event."
},
"created": {
"type": "string",
"example": "2016-05-16T21:34:59.324Z",
"description": "The date and time of the event."
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk"
},
"roomId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0"
},
"roomType": {
"type": "string",
"example": "group"
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jZTg2MWZiYS02ZTJmLTQ5ZjktOWE4NC1iMzU0MDA4ZmFjOWU"
},
"text": {
"type": "string",
"example": "PROJECT UPDATE - A new project plan has been published on Box: http://box.com/s/lf5vj. The PM for this project is Mike C. and the Engineering Manager is Jane W."
},
"personId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY"
},
"personEmail": {
"type": "string",
"example": "matt@example.com"
},
"meetingId": {
"type": "string",
"example": "16ce696f75844d24b2d4fab04b4419af_I_183979003076423608"
},
"creatorId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS82YWE2ZGE5OS0xYzdlLTQ4MWItODY3YS03MWY2NTIwNDk0MzM"
},
"host": {
"type": "object",
"properties": {},
"description": "The meeting's host data."
},
"attendees": {
"type": "array",
"items": {},
"description": "Common Identity (CI) authenticated meeting attendees."
},
"transcriptionEnabled": {
"type": "string",
"example": "yes",
"description": "Indicates whether or not the Voice Assistant was enabled during the meeting. If `true` a transcript should be available a couple minutes after the meeting ended at the [meetingTranscripts resource](/docs/api/v1/meeting-transcripts)."
},
"recordingEnabled": {
"type": "string",
"example": "yes",
"description": "Indicates if recording was enabled for all or parts of the meeting. If `true` a recording should be available shortly after the meeting ended at the [recordings resource](/docs/api/v1/recordings)."
},
"hasPostMeetingsChat": {
"type": "string",
"example": "yes",
"description": "Indicates if chat messages were exchanged during the meeting in the meetings client (not the unified client). If `true` these messages can be accessed by a compliance officer at the [postMeetingsChat](/docs/api/v1/meetings-chat) resource. Meetings chat collection must be custom enabled."
},
"corelationId": {
"type": "string",
"example": "fdda8613-d34b-424c-8c6a-44ff2e19379c",
"description": "Telephony; The corelation id."
},
"callType": {
"type": "string",
"example": "SIP_ENTERPRISE",
"description": "Telephony; call types (examples `VIDEO_DIALIN`,`VIDEO_DIALOUT`,`CASCADE`,`HYBRID_CASCADE`,`PSTN_SIP`,`PSTN_DIALIN`,`PSTN_DIALOUT`,`PSTN_ONLY_DIALIN`,`PSTN_ONLY_DIALOUT`,`H323`,`H323_IP`,`SIP_ENTERPRISE`,`SIP_MOBILE`,`SIP_NATIONAL`,`SIP_INTERNATIONAL`,`SIP_EMERGENCY`,`SIP_OPERATOR`,`SIP_SHORTCODE`,`SIP_TOLLFREE`,`SIP_PREMIUM`,`SIP_URI`,`SIP_INBOUND`,`UNKNOWN`,`ZTM`,`SIP_MEETING`)."
},
"userId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZjEwMTU1NC04ZGJjLTQyMmUtOGEzZC1kYTk1YTI3NWZlNzU",
"description": "Telephony; user id of the CDR owner."
},
"userType": {
"type": "string",
"example": "User",
"description": "Telephony; The type of user (`User`,`Anchor`,`AutomatedAttendantBasic`,`AutomatedAttendantStandard`,`AutomatedAttendantVideo`,`BroadworksAnywhere`,`CallCenterBasic`,`CallCenterPremium`,`CallCenterStandard`,`CollaborateBridge`,`ContactCenterAdaptor`,`FindMeFollowMe`,`FlexibleSeatingHost`,`GroupCall`,`GroupPaging`,`HuntGroup`,`LocalGateway`,`MeetMeConference`,`Place`,`RoutePoint`,`SystemVoicePortal`,`VoiceMailGroup`,`VoiceMailRetrieval`,`VoiceXML`,`VirtualLine`,`Unknown`)."
},
"callDirection": {
"type": "string",
"example": "ORIGINTATING",
"description": "Telephony; `ORIGINATING` or `TERMINATING`."
},
"isCallAnswered": {
"type": "string",
"example": "true",
"description": "Telephony; indicates if the call was answered."
},
"callDurationSeconds": {
"type": "string",
"example": "192",
"description": "Telephony; duration of call in seconds."
},
"callStartTime": {
"type": "string",
"example": "2023-02-08T06:12:43.976Z",
"description": "Telephony; ISO 8601."
},
"callAnswerTime": {
"type": "string",
"example": "2023-02-08T06:12:47.012Z",
"description": "Telephony; ISO 8601."
},
"callTransferTime": {
"type": "string",
"example": "2023-02-08T06:15:19.112Z",
"description": "Telephony; ISO 8601."
},
"callingNumber": {
"type": "string",
"example": "910481234",
"description": "Telephony; originating number."
},
"callingLineId": {
"type": "string",
"example": "211",
"description": "Telephony."
},
"calledNumber": {
"type": "string",
"example": "4089671221",
"description": "Telephony; destination number."
},
"calledLineId": {
"type": "string",
"example": "219",
"description": "Telephony"
},
"dialedDigits": {
"type": "string",
"example": "123",
"description": "Telephony"
},
"callRedirectingNumber": {
"type": "string",
"description": "Telephony"
},
"callRedirectedReason": {
"type": "string",
"description": "Telephony"
},
"created": {
"type": "string",
"example": "2016-05-16T21:34:59.324Z"
},
"type": {
"type": "string",
"example": "direct",
"description": "Message type `direct` or `group` message."
},
"breakoutSessionId": {
"type": "string",
"example": "d66a4a90-4f50-11ef-bc94-f5c71646dc71",
"description": "The breakout session Id in cases where the action happened in a meeting's brakout session, for example a `meetingMessage`."
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Recipient"
},
"description": "The recipients list for directed meetingMessages."
}
},
"description": "The event's data representation. This object will contain the event's `resource`, such as [memberships](/docs/api/v1/memberships/get-membership-details), [messages](/docs/api/v1/messages/get-message-details), [meetings](/docs/api/v1/meetings), [meetingMessages](/docs/api/v1/meetingMessages), [tabs](/docs/api/v1/room-tabs), [rooms](/docs/api/v1/space-classifications) or [attachmentActions](/docs/api/v1/attachment-actions) at the time the event took place."
}
}
},
"EventCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Event"
}
}
}
},
"EventResourceEnum": {
"type": "string",
"enum": [
"attachmentActions",
"businessTexts",
"call_records",
"convergedRecordings",
"file_transcodings",
"files",
"meetingMessages",
"meetings",
"meetingTranscripts",
"memberships",
"messages",
"rooms",
"tabs"
],
"description": " * `attachmentActions` - State changed on a card attachment\n * `businessTexts` - A user sent or received a SMS message\n * `call_records` - A Webex call was made to/from a user\n * `convergedRecordings` - A Webex call was recorded for a user\n * `file_transcodings` - State change on a file preview\n * `files` - State changed on a file download\n * `meetingMessages` - State changed on a meeting message, i.e. message exchanged as part of a meeting\n * `meetings` - State change on a meeting ( here combined with type = 'ended' )\n * `meetingTranscripts` - State change on a automatic transcript resource for Webex Assistant\n * `memberships` - State changed on a memberships resource\n * `messages` - State changed on a messages resource\n * `rooms` - State changed on a space classification\n * `tabs` - State changed on a room tabs in a space\n"
},
"EventTypeEnum": {
"type": "string",
"enum": [
"created",
"updated",
"deleted",
"ended"
],
"description": " * `created` - The resource has been created\n * `updated` - A property on the resource has been updated\n * `deleted` - The resource has been deleted\n * `ended` - The meeting has ended\n"
},
"Recipient": {
"type": "object",
"properties": {
"personId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lOGYwOTIwOC00ZjUxLTExZWYtOTQ4My1iYTA3NjE2MzY4NmQ",
"description": "The personId of the recipient"
},
"personEmail": {
"type": "string",
"example": "johndoe@simplistic.com",
"description": "The personEmail"
},
"guestDisplayName": {
"type": "string",
"example": "John Wayne",
"description": "Guests, who are unauthenticated users, have a guestDisplayName"
},
"guestEmail": {
"type": "string",
"example": "jwayne@mailinator.com",
"description": "Guests, who are unauthenticated users, have a guestEmail"
}
}
},
"HotDeskSessionsResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HotDesk"
}
}
}
},
"HotDesk": {
"type": "object",
"properties": {
"sessionId": {
"type": "string",
"example": "Y2lzY29...",
"description": "A unique identifier for a hot desk session."
},
"workspaceId": {
"type": "string",
"example": "YL34EmB...",
"description": "The workspace where the hot desk session is active."
},
"personId": {
"type": "string",
"example": "YL34EmA...",
"description": "The id of the person who initiated the hot desk session."
},
"bookingStartTime": {
"type": "string",
"example": "2024-08-29T12:00:00Z",
"description": "The start time of the booking."
},
"bookingEndTime": {
"type": "string",
"example": "2024-08-29T20:00:00Z",
"description": "The end time of the booking."
}
}
},
"Location": {
"type": "object",
"required": [
"address",
"countryCode",
"latitude",
"longitude"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"description": "Unique identifier for the location."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzA2OWEzMDY2LTgwNjMtNDI0Zi05YmE0LTBhZDdhMmYxMzNjNQ",
"description": "The ID to use for this location in the [/locations API](/docs/api/v1/locations)"
},
"displayName": {
"type": "string",
"example": "Cisco Barcelona",
"description": "A friendly name for the location."
},
"address": {
"type": "string",
"example": "Carrer de Pere IV, Barcelona, Spain",
"description": "The location address."
},
"countryCode": {
"type": "string",
"example": "ES",
"description": "The location country code (ISO 3166-1)."
},
"cityName": {
"type": "string",
"example": "Barcelona",
"description": "The location city name."
},
"latitude": {
"type": "number",
"example": 41.406615,
"description": "The location latitude."
},
"longitude": {
"type": "number",
"example": 2.200717,
"description": "The location longitude."
},
"notes": {
"type": "string",
"example": "A note about the location",
"description": "Notes associated with the location."
}
}
},
"PutCommonLocationObject": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Denver",
"description": "The name of the location. Supports up to 256 characters, but locations enabled for Webex Calling are limited to 80 characters maximum."
},
"timeZone": {
"type": "string",
"example": "America/Chicago",
"description": "Time zone associated with this location, refer to this link (https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide#webex-meetings-site-timezone) for format."
},
"preferredLanguage": {
"type": "string",
"example": "en_us",
"description": "Default email language."
},
"address": {
"type": "object",
"properties": {
"address1": {
"type": "string",
"example": "123 Some St.",
"description": "Address 1"
},
"address2": {
"type": "string",
"example": "Suite 456",
"description": "Address 2"
},
"city": {
"type": "string",
"example": "Supercity",
"description": "City"
},
"state": {
"type": "string",
"example": "Goodstate",
"description": "State code"
},
"postalCode": {
"type": "string",
"example": "12345",
"description": "Postal Code"
},
"country": {
"type": "string",
"example": "US",
"description": "ISO-3166 2-Letter Country Code."
}
},
"description": "The address of the location."
}
}
},
"PostCommonLocationObject": {
"type": "object",
"required": [
"name",
"timeZone",
"preferredLanguage",
"announcementLanguage",
"address"
],
"properties": {
"name": {
"type": "string",
"example": "Denver",
"description": "The name of the location. Supports up to 256 characters, but locations enabled for Webex Calling are limited to 80 characters maximum."
},
"timeZone": {
"type": "string",
"example": "America/Chicago",
"description": "Time zone associated with this location, refer to this link (https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide#webex-meetings-site-timezone) for format."
},
"preferredLanguage": {
"type": "string",
"example": "en_us",
"description": "Default email language."
},
"announcementLanguage": {
"type": "string",
"example": "fr_fr",
"description": "Location's phone announcement language."
},
"address": {
"type": "object",
"required": [
"address1",
"city",
"state",
"postalCode",
"country"
],
"properties": {
"address1": {
"type": "string",
"example": "123 Some St.",
"description": "Address 1"
},
"address2": {
"type": "string",
"example": "Suite 456",
"description": "Address 2"
},
"city": {
"type": "string",
"example": "Supercity",
"description": "City"
},
"state": {
"type": "string",
"example": "Goodstate",
"description": "State code"
},
"postalCode": {
"type": "string",
"example": "12345",
"description": "Postal Code"
},
"country": {
"type": "string",
"example": "US",
"description": "ISO-3166 2-Letter Country Code."
}
},
"description": "The address of the location."
},
"latitude": {
"type": "string",
"example": "12.935784",
"description": "Latitude"
},
"longitude": {
"type": "string",
"example": "77.697332",
"description": "Longitude"
},
"notes": {
"type": "string",
"example": "123 Some St. Denver Location",
"description": "Notes"
}
}
},
"LocationsCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
}
}
}
},
"Floor": {
"type": "object",
"required": [
"floorNumber"
],
"properties": {
"id": {
"type": "string",
"example": "xxx==",
"description": "Unique identifier for the floor."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"description": "Unique identifier for the location."
},
"floorNumber": {
"type": "number",
"example": -1,
"description": "The floor number."
},
"displayName": {
"type": "string",
"example": "The basement",
"description": "The floor display name."
}
}
},
"FloorUpdated": {
"type": "object",
"required": [
"floorNumber"
],
"properties": {
"id": {
"type": "string",
"example": "xxx==",
"description": "Unique identifier for the floor."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"description": "Unique identifier for the location."
},
"floorNumber": {
"type": "number",
"example": 1,
"description": "The floor number."
},
"displayName": {
"type": "string",
"example": "My custom name",
"description": "The floor display name."
}
}
},
"FloorCreationRequest": {
"type": "object",
"required": [
"floorNumber"
],
"properties": {
"floorNumber": {
"type": "number",
"example": -1,
"description": "The floor number."
},
"displayName": {
"type": "string",
"example": "The basement",
"description": "The floor display name."
}
}
},
"FloorUpdateRequest": {
"type": "object",
"required": [
"floorNumber"
],
"properties": {
"floorNumber": {
"type": "number",
"example": 1,
"description": "The floor number."
},
"displayName": {
"type": "string",
"example": "My custom name",
"description": "The floor display name."
}
}
},
"FloorCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Floor"
},
"description": "An array of floor objects."
}
}
},
"MeetingQualitiesResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaSessionQuality"
}
}
}
},
"MediaSessionQuality": {
"type": "object",
"required": [
"meetingInstanceId"
],
"properties": {
"meetingInstanceId": {
"type": "string",
"example": "e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470",
"description": "The meeting identifier for the specific meeting instance."
},
"webexUserName": {
"type": "string",
"example": "John Andersen",
"description": "The display name of the participant of this media session."
},
"webexUserEmail": {
"type": "string",
"example": "john.andersen@example.com",
"description": "The email address of the participant of this media session."
},
"joinTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this participant joined the meeting."
},
"leaveTime": {
"type": "string",
"example": "2020-04-10T17:02:00.000Z",
"description": "The date and time when this participant left the meeting."
},
"joinMeetingTime": {
"type": "string",
"example": "5.793",
"description": "The join meeting time of the participant. "
},
"clientType": {
"type": "string",
"example": "Teams_Mobile_Client (iOS)",
"description": "The type of the client (and OS) used by this media session."
},
"clientVersion": {
"type": "string",
"example": "40.5.0.210",
"description": "The version of the client used by this media session."
},
"osType": {
"type": "string",
"example": "mac",
"description": "The operating system used for the client."
},
"osVersion": {
"type": "string",
"example": "Version 10.14.6 (Build 18G3020)",
"description": "The version of the operating system used for the client."
},
"hardwareType": {
"type": "string",
"example": "mac book",
"description": "The type of hardware used to attend the meeting"
},
"speakerName": {
"type": "string",
"example": "MacBook Pro Speakers",
"description": "A description of the speaker used in the meeting."
},
"networkType": {
"type": "string",
"enum": [
"wifi",
"cellular",
"ethernet",
"unknown"
],
"description": "The type of network."
},
"localIP": {
"type": "string",
"example": "10.24.72.54",
"description": "The local IP address of the client."
},
"publicIP": {
"type": "string",
"example": "10.24.72.54",
"description": "The public IP address of the client."
},
"maskedLocalIP": {
"type": "string",
"example": "10.24.72.54",
"description": "The masked local IP address of the client."
},
"maskedPublicIP": {
"type": "string",
"example": "10.24.72.54",
"description": "The masked public IP address of the client."
},
"camera": {
"type": "string",
"example": "FaceTime HD Camera",
"description": "A description of the camera used in the meeting."
},
"microphone": {
"type": "string",
"example": "External Microphone",
"description": "A description of the microphone used in the meeting."
},
"serverRegion": {
"type": "string",
"example": "San Jose, USA",
"description": "The server region."
},
"videoMeshCluster": {
"type": "string",
"example": "Mesh Cluster One",
"description": "The video mesh cluster name."
},
"videoMeshServer": {
"type": "string",
"example": "server.example.com",
"description": "The video mesh server name."
},
"participantId": {
"type": "string",
"example": "8635cbf0ca1a4573b27348e560679b25_I_158174534545967299_57",
"description": "Identifies the participant."
},
"participantSessionId": {
"type": "string",
"example": "3324C9D0-9EA7-45A2-B249-5B62A384AFEF",
"description": "Identifies a specific session the participant has in a given meeting."
},
"videoIn": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VideoIn"
},
"description": "The collection of downstream (sent to the client) video quality data."
},
"videoOut": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VideoOut"
},
"description": "The collection of upstream (sent from the client) video quality data."
},
"audioIn": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudioIn"
},
"description": "The collection of downstream (sent to the client) audio quality data."
},
"audioOut": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudioOut"
},
"description": "The collection of upstream (sent from the client) audio quality data."
},
"shareIn": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareIn"
},
"description": "The collection of downstream (sent to the client) share quality data."
},
"shareOut": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareOut"
},
"description": "The collection of upstream (sent from the client) share quality data."
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resources"
},
"description": "Device resources such as CPU and memory."
}
}
},
"VideoIn": {
"type": "object",
"properties": {
"samplingInterval": {
"type": "number",
"example": 60,
"description": "The sampling interval, in seconds, of the downstream video quality data."
},
"startTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this video session started."
},
"endTime": {
"type": "string",
"example": "2020-04-10T18:00:00.000Z",
"description": "The date and time when this video session ended."
},
"packetLoss": {
"type": "array",
"items": {
"type": "number"
},
"description": "The percentage of video packet loss, as a float between 0.0 and 100.0, during each sampling interval."
},
"latency": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average latency, in milliseconds, during each sampling interval."
},
"resolutionHeight": {
"type": "array",
"items": {
"type": "number"
},
"description": "The pixel height of the incoming video."
},
"frameRate": {
"type": "array",
"items": {
"type": "number",
"example": 25.940001
},
"description": "The frames per second of the incoming video."
},
"mediaBitRate": {
"type": "array",
"items": {
"type": "number"
},
"description": "The bit rate of the incoming video."
},
"codec": {
"type": "string",
"example": "H.264 BP",
"description": "The incoming video codec."
},
"jitter": {
"type": "array",
"items": {
"type": "number",
"example": 170
},
"description": "The incoming video jitter."
},
"transportType": {
"type": "string",
"enum": [
"UDP",
"TCP"
],
"description": "The network protocol used for video transmission."
}
}
},
"VideoOut": {
"type": "object",
"properties": {
"samplingInterval": {
"type": "number",
"example": 60,
"description": "The sampling interval, in seconds, of the upstream video quality data."
},
"startTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this video session started."
},
"endTime": {
"type": "string",
"example": "2020-04-10T18:00:00.000Z",
"description": "The date and time when this video session ended."
},
"packetLoss": {
"type": "array",
"items": {
"type": "number"
},
"description": "The percentage of video packet loss, in float between 0.0 and 100.0, during each sampling interval."
},
"latency": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average latency, in milliseconds, during each sampling interval."
},
"resolutionHeight": {
"type": "array",
"items": {
"type": "number"
},
"description": "The pixel height of the outgoing video."
},
"frameRate": {
"type": "array",
"items": {
"type": "number",
"example": 25.940001
},
"description": "The frames per second of the outgoing video."
},
"mediaBitRate": {
"type": "array",
"items": {
"type": "number"
},
"description": "The bit rate of the outgoing video."
},
"codec": {
"type": "string",
"example": "H.264 BP",
"description": "The outgoing video codec."
},
"jitter": {
"type": "array",
"items": {
"type": "number"
},
"description": "The outgoing video jitter."
},
"transportType": {
"type": "string",
"enum": [
"UDP",
"TCP"
],
"description": "The network protocol used for video transmission."
}
}
},
"AudioIn": {
"type": "object",
"properties": {
"samplingInterval": {
"type": "number",
"example": 60,
"description": "The sampling interval, in seconds, of the downstream audio quality data."
},
"startTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this audio session started."
},
"endTime": {
"type": "string",
"example": "2020-04-10T18:00:00.000Z",
"description": "The date and time when this audio session ended."
},
"packetLoss": {
"type": "array",
"items": {
"type": "number"
},
"description": "The percentage of audio packet loss, as a float between 0.0 and 100.0, during each sampling interval."
},
"latency": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average latency, in milliseconds, during each sampling interval."
},
"resolutionHeight": {
"type": "array",
"items": {
"type": "number"
},
"description": "Not applicable to audio."
},
"frameRate": {
"type": "array",
"items": {
"type": "number",
"example": 25.940001
},
"description": "Not applicable to audio."
},
"mediaBitRate": {
"type": "array",
"items": {
"type": "number"
},
"description": "The bitrate of the incoming audio."
},
"codec": {
"type": "string",
"example": "Opus",
"description": "The codec of the incoming audio."
},
"jitter": {
"type": "array",
"items": {
"type": "number"
},
"description": "The incoming audio jitter."
},
"transportType": {
"type": "string",
"enum": [
"UDP",
"TCP"
],
"description": "The network protocol used for video transmission."
}
}
},
"AudioOut": {
"type": "object",
"properties": {
"samplingInterval": {
"type": "number",
"example": 60,
"description": "The sampling interval, in seconds, of the upstream audio quality data."
},
"startTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this audio session started."
},
"endTime": {
"type": "string",
"example": "2020-04-10T18:00:00.000Z",
"description": "The date and time when this audio session ended."
},
"packetLoss": {
"type": "array",
"items": {
"type": "number"
},
"description": "The percentage of audio packet loss, as a float between 0.0 and 100.0, during each sampling interval."
},
"latency": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average latency, in milliseconds, during each sampling interval."
},
"resolutionHeight": {
"type": "array",
"items": {
"type": "number"
},
"description": "Not applicable to audio out."
},
"frameRate": {
"type": "array",
"items": {
"type": "number",
"example": 25.940001
},
"description": "Not applicable to audio out."
},
"mediaBitRate": {
"type": "array",
"items": {
"type": "number"
},
"description": "The bit rate of the outgoing audio."
},
"codec": {
"type": "string",
"example": "Opus",
"description": "The audio codec."
},
"jitter": {
"type": "array",
"items": {
"type": "number"
},
"description": "The outgoing audio jitter."
},
"transportType": {
"type": "string",
"enum": [
"UDP",
"TCP"
],
"description": "The network protocol used for video transmission."
}
}
},
"ShareIn": {
"type": "object",
"properties": {
"samplingInterval": {
"type": "number",
"example": 60,
"description": "The sampling interval, in seconds, of the downstream content sharing data."
},
"startTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this content sharing session started."
},
"endTime": {
"type": "string",
"example": "2020-04-10T18:00:00.000Z",
"description": "The date and time when this content sharing session ended."
},
"packetLoss": {
"type": "array",
"items": {
"type": "number"
},
"description": "The percentage of content sharing packet loss, as a float between 0.0 and 100.0, during each sampling interval."
},
"latency": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average latency, in milliseconds, during each sampling interval."
},
"resolutionHeight": {
"type": "array",
"items": {
"type": "number"
},
"description": "The height in pixels of the incoming share video."
},
"frameRate": {
"type": "array",
"items": {
"type": "number",
"example": 25.940001
},
"description": "The frame rate of the incoming share video."
},
"mediaBitRate": {
"type": "array",
"items": {
"type": "number"
},
"description": "The bit rate for the incoming share video."
},
"codec": {
"type": "string",
"example": "H.264 BP",
"description": "The codec for the incoming share video."
},
"jitter": {
"type": "array",
"items": {
"type": "number"
},
"description": "The jitter for the incoming share video."
},
"transportType": {
"type": "string",
"enum": [
"UDP",
"TCP"
],
"description": "The network protocol used for video transmission."
}
}
},
"ShareOut": {
"type": "object",
"properties": {
"samplingInterval": {
"type": "number",
"example": 60,
"description": "The sampling interval, in seconds, of the upstream content sharing data."
},
"startTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this content sharing session started."
},
"endTime": {
"type": "string",
"example": "2020-04-10T18:00:00.000Z",
"description": "The date and time when this content sharing session ended."
},
"packetLoss": {
"type": "array",
"items": {
"type": "number"
},
"description": "The percentage of content sharing packet loss, in float between 0.0 and 100.0, during each sampling interval."
},
"latency": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average latency, in milliseconds, during each sampling interval."
},
"resolutionHeight": {
"type": "array",
"items": {
"type": "number"
},
"description": "The height in pixels of the outgoing share video."
},
"frameRate": {
"type": "array",
"items": {
"type": "number",
"example": 25.940001
},
"description": "The frame rate of the outgoing share video."
},
"mediaBitRate": {
"type": "array",
"items": {
"type": "number"
},
"description": "The bit rate of the outgoing share video."
},
"codec": {
"type": "string",
"example": "H.264 BP",
"description": "The codec of the outgoing share video."
},
"jitter": {
"type": "array",
"items": {
"type": "number"
},
"description": "The jitter for the outgoing share video."
},
"transportType": {
"type": "string",
"enum": [
"UDP",
"TCP"
],
"description": "The network protocol used for video transmission."
}
}
},
"Resources": {
"type": "object",
"properties": {
"processAverageCPU": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average percent CPU for the process."
},
"processMaxCPU": {
"type": "array",
"items": {
"type": "number"
},
"description": "The max percent CPU for the process."
},
"systemAverageCPU": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average percent CPU for the system."
},
"systemMaxCPU": {
"type": "array",
"items": {
"type": "number"
},
"description": "The max percent CPU for the system."
}
}
},
"Report": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
"description": "Unique identifier for the report."
},
"title": {
"type": "string",
"example": "Bots Activity",
"description": "Name of the template to which this report belongs."
},
"service": {
"type": "string",
"example": "Teams",
"description": "The service to which the report belongs."
},
"startDate": {
"type": "string",
"example": "2020-02-23",
"description": "The data in this report belongs to dates greater than or equal to this."
},
"endDate": {
"type": "string",
"example": "2020-03-24",
"description": "The data in this report belongs to dates smaller than or equal to this."
},
"siteList": {
"type": "string",
"example": "cisco.webex.com",
"description": "The site to which this report belongs to. This only exists if the report belongs to service `Webex`."
},
"created": {
"type": "string",
"example": "2020-03-24 17:13:39",
"description": "Time of creation for this report."
},
"createdBy": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
"description": "The person who created the report."
},
"scheduledFrom": {
"type": "string",
"example": "API",
"description": "Whether this report was scheduled from API or Control Hub."
},
"status": {
"type": "string",
"example": "done",
"description": "Completion status of this report."
},
"downloadURL": {
"type": "string",
"example": "https://downloadservicebts.webex.com/api?reportId=Y2lzY29zcGFyazovL3VzL1JFUE9SVC9hZDBkMjA1NzVkYTA0NWE0OGZhZDQ3ZDk3NGFiNDFmMg",
"description": "The link from which the report can be downloaded."
}
}
},
"ReportCollectionResponse": {
"type": "object",
"properties": {
"Report Attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Report"
},
"description": "An array of report objects."
}
}
},
"Template": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "130",
"description": "Unique identifier representing a report."
},
"title": {
"type": "string",
"example": "Client Version",
"description": "Name of the template."
},
"service": {
"type": "string",
"example": "Teams",
"description": "The service to which the report belongs."
},
"maxDays": {
"type": "number",
"example": 31,
"description": "Maximum date range for reports belonging to this template."
},
"identifier": {
"type": "string",
"example": "orgWithoutDate",
"description": "Generated reports belong to which field."
},
"validations": {
"$ref": "#/components/schemas/ValidationRulesCollection"
}
}
},
"TemplateCollectionResponse": {
"type": "object",
"properties": {
"Template Collection": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Template"
},
"description": "An array of template objects."
}
}
},
"Person": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"description": "A unique identifier for the person."
},
"emails": {
"type": "array",
"items": {
"type": "string",
"example": "john.andersen@example.com"
},
"description": "The email addresses of the person."
},
"phoneNumbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"work",
"work_extension",
"mobile",
"fax"
],
"description": "The type of phone number.\n * `work` - Work phone number of the person.\n * `work_extension` - Work extension of the person. For the Webex Calling person, the value will have a routing prefix along with the extension.\n * `mobile` - Mobile number of the person.\n * `fax` - FAX number of the person.\n"
},
"value": {
"type": "string",
"example": "+1 408 526 7209",
"description": "The phone number."
},
"primary": {
"type": "boolean",
"example": true,
"description": "Primary number for the person."
}
}
},
"description": "Phone numbers for the person."
},
"extension": {
"type": "string",
"example": "133",
"description": "The Webex Calling extension for the person. Only applies to a person with a Webex Calling license."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"description": "The ID of the location for this person retrieved from BroadCloud."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "The full name of the person."
},
"nickName": {
"type": "string",
"example": "John",
"description": "The nickname of the person if configured. If no nickname is configured for the person, this field will not be present."
},
"firstName": {
"type": "string",
"example": "John",
"description": "The first name of the person."
},
"lastName": {
"type": "string",
"example": "Andersen",
"description": "The last name of the person."
},
"avatar": {
"type": "string",
"example": "https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600",
"description": "The URL to the person's avatar in PNG format."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The ID of the organization to which this person belongs."
},
"roles": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
},
"description": "An array of role strings representing the roles to which this admin user belongs."
},
"licenses": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
},
"description": "An array of license strings allocated to this person."
},
"department": {
"type": "string",
"example": "Sales",
"description": "The business department the user belongs to."
},
"manager": {
"type": "string",
"example": "John Duarte",
"description": "A manager identifier."
},
"managerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80ZGEzYTI0OC05YjBhLTQxMDgtODU0NC1iNTQwMzEyZTU2M2E",
"description": "Person ID of the manager."
},
"title": {
"type": "string",
"example": "GM",
"description": "The person's title."
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "work",
"description": "The type of address."
},
"country": {
"type": "string",
"example": "US",
"description": "The user's country."
},
"locality": {
"type": "string",
"example": "Milpitas",
"description": "The user's locality, often city."
},
"region": {
"type": "string",
"example": "California",
"description": "The user's region, often state."
},
"streetAddress": {
"type": "string",
"example": "1099 Bird Ave.",
"description": "The user's street."
},
"postalCode": {
"type": "string",
"example": "99212",
"description": "The user's postal or zip code."
}
}
},
"description": "A person's addresses."
},
"created": {
"type": "string",
"example": "2015-10-18T14:26:16.000Z",
"description": "The date and time the person was created."
},
"lastModified": {
"type": "string",
"example": "2015-10-18T14:26:16.000Z",
"description": "The date and time the person was last changed."
},
"timezone": {
"type": "string",
"example": "America/Denver",
"description": "The time zone of the person if configured. If no timezone is configured on the account, this field will not be present."
},
"lastActivity": {
"type": "string",
"example": "2015-10-18T14:26:16.028Z",
"description": "The date and time of the person's last activity within Webex. This will only be returned for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/)."
},
"siteUrls": {
"type": "array",
"items": {
"type": "string",
"example": "mysite.webex.com#attendee"
},
"description": "One or several site names where this user has a role (host or attendee)."
},
"sipAddresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"personal-room",
"enterprise",
"cloud-calling"
],
"description": "The type of SIP address.\n * `personal-room` - Personal room address.\n * `enterprise` - Enterprise address.\n * `cloud-calling` - Cloud calling address.\n"
},
"value": {
"type": "string",
"example": "testuser5@mycompany.webex.com",
"description": "The SIP address."
},
"primary": {
"type": "boolean",
"description": "Primary SIP address of the person."
}
}
},
"description": "The user's SIP addresses. Read-only."
},
"xmppFederationJid": {
"type": "string",
"example": "user@example.com",
"description": "Identifier for intra-domain federation with other XMPP based messenger systems."
},
"status": {
"type": "string",
"enum": [
"active",
"call",
"DoNotDisturb",
"inactive",
"meeting",
"OutOfOffice",
"pending",
"presenting",
"unknown"
],
"description": "The current presence status of the person. This will only be returned for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/). Presence status is different from Control Hub's \"Last Service Access Time\" which indicates the last time an oAuth token was issued for this user.\n * `active` - Active within the last 10 minutes.\n * `call` - The user is in a call.\n * `DoNotDisturb` - The user has manually set their status to \"Do Not Disturb\".\n * `inactive` - Last activity occurred more than 10 minutes ago.\n * `meeting` - The user is in a meeting.\n * `OutOfOffice` - The user or a Hybrid Calendar service has indicated that they are \"Out of Office\".\n * `pending` - The user has never logged in; a status cannot be determined.\n * `presenting` - The user is sharing content.\n * `unknown` - The user’s status could not be determined.\n"
},
"invitePending": {
"type": "string",
"enum": [
"true",
"false"
],
"description": "Whether or not an invite is pending for the user to complete account activation. This property is only returned if the authenticated user is an admin user for the person's organization.\n * `true` - The person has been invited to Webex but has not created an account.\n * `false` - An invite is not pending for this person.\n"
},
"loginEnabled": {
"type": "string",
"enum": [
"true",
"false"
],
"description": "Whether or not the user is allowed to use Webex. This property is only returned if the authenticated user is an admin user for the person's organization.\n * `true` - The person _can_ log into Webex.\n * `false` - The person _cannot_ log into Webex.\n"
},
"type": {
"type": "string",
"enum": [
"person",
"bot",
"appuser"
],
"description": "The type of person account, such as person or bot.\n * `person` - Account belongs to a person.\n * `bot` - Account is a bot user.\n * `appuser` - Account is a [guest user](/docs/guest-issuer).\n"
}
}
},
"PersonCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Person"
},
"description": "An array of person objects."
},
"notFoundIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of person IDs that could not be found."
}
}
},
"RecordingReportSummaryObject": {
"type": "object",
"properties": {
"recordingId": {
"type": "string",
"example": "4f914b1dfe3c4d11a61730f18c0f5387",
"description": "A unique identifier for the recording."
},
"topic": {
"type": "string",
"example": "John's Meeting",
"description": "The recording's topic."
},
"timeRecorded": {
"type": "string",
"example": "2019-01-27T17:40:20Z",
"description": "The date and time the recording started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. the time is the record button was clicked in the meeting."
},
"siteUrl": {
"type": "string",
"example": "site4-example.webex.com",
"description": "Site URL for the recording."
},
"hostEmail": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting host."
},
"viewCount": {
"type": "number",
"example": 7,
"description": "The number of times the recording was viewed."
},
"downloadCount": {
"type": "number",
"example": 20,
"description": "The number of times the recording was downloaded."
}
}
},
"RecordingReportObject": {
"type": "object",
"properties": {
"recordingId": {
"type": "string",
"example": "4f914b1dfe3c4d11a61730f18c0f5387",
"description": "A unique identifier for the recording."
},
"topic": {
"type": "string",
"example": "John's Meeting",
"description": "The recording's topic."
},
"name": {
"type": "string",
"example": "John Andersen",
"description": "The name of the person who accessed the recording."
},
"email": {
"type": "string",
"example": "john.andersen@example.com",
"description": "The email address of the person who accessed the recording."
},
"accessTime": {
"type": "string",
"example": "2019-01-27T17:40:20Z",
"description": "The date and time the recording was accessed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"viewed": {
"type": "boolean",
"example": true,
"description": "Whether or not the recording was viewed by the person."
},
"downloaded": {
"type": "boolean",
"example": true,
"description": "Whether or not the recording was downloaded by the person."
}
}
},
"RecordingAchriveSummaryObject": {
"type": "object",
"properties": {
"archiveId": {
"type": "string",
"example": "7d7ea5f42b921eace05386ca24ad730e_R_1000634462",
"description": "A unique identifier for the meeting archive summary."
},
"serviceType": {
"type": "string",
"enum": [
"MeetingCenter",
"EventCenter",
"TrainingCenter",
"SupportCenter"
],
"description": "Recording achrive summary's service-type."
},
"title": {
"type": "string",
"example": "John's Meeting",
"description": "Meeting title."
},
"createTime": {
"type": "string",
"example": "2019-01-27T17:43:24Z",
"description": "The date and time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format that when the archive was created by the system."
}
}
},
"RecordingArchiveReportObject": {
"type": "object",
"properties": {
"archiveId": {
"type": "string",
"example": "7d7ea5f42b921eace05386ca24ad730e_R_1000634462",
"description": "A unique identifier for the meeting archive summary."
},
"serviceType": {
"type": "string",
"enum": [
"MeetingCenter",
"EventCenter",
"TrainingCenter",
"SupportCenter"
],
"description": "Recording achrive report's service-type."
},
"title": {
"type": "string",
"example": "John's Meeting",
"description": "Meeting title."
},
"start": {
"type": "string",
"example": "2019-03-18T11:26:30Z",
"description": "Start time for meeting in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"end": {
"type": "string",
"example": "2019-03-18T12:26:30Z",
"description": "End time for a meeting in ISO 8601 compliant format."
},
"hostDisplayName": {
"type": "string",
"example": "John Andersen",
"description": "Display name for the meeting host."
},
"hostEmail": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting host."
},
"participants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveParticipant"
},
"description": "The participants of the meeting archive."
},
"chats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveChat"
},
"description": "The chats of the meeting archive."
},
"polls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchivePoll"
},
"description": "The polls of the meeting archive."
},
"qas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveQA"
},
"description": "Meeting meeting archive's Q and A."
},
"systemInfos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveSystemInfo"
},
"description": "The system Information of the meeting archive, which can be only supported when serviceType is `SupportCenter`."
}
}
},
"MeetingRecordingArchiveParticipant": {
"type": "object",
"properties": {
"correlationId": {
"type": "number",
"example": 28208023,
"description": "An internal ID that is associated with each join."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "Display name for the meeting participant."
},
"joinedTime": {
"type": "string",
"example": "2022-07-20T07:01:31Z",
"description": "The time the participant joined the meeting."
},
"leftTime": {
"type": "string",
"example": "2022-07-20T07:01:31Z",
"description": "The time the participant left the meeting."
},
"email": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting participant."
}
}
},
"MeetingRecordingArchiveChat": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "private",
"description": "Whether the type of the chat is private, public or group. Private chat is for the 1:1 chat. Public chat is for the message which is sent to all the people in the meeting. Group chat is for the message which is sent to a small group of people, like a message to the \"host and presenter\"."
},
"senderName": {
"type": "string",
"example": "John Andersen",
"description": "Display name for the sender of the chat snippet."
},
"chatTime": {
"type": "string",
"example": "2021-07-06T09:22:34Z",
"description": "Chat time for the chat snippet in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"target": {
"type": "string",
"example": "All Participants",
"description": "Information of the receivers of the chat snippet."
},
"text": {
"type": "string",
"example": "It's nice to meet you",
"description": "The text of the chat snippet."
}
}
},
"MeetingRecordingArchivePoll": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "single",
"description": "The type of the question."
},
"startTime": {
"type": "string",
"example": "2021-07-06T09:25:34Z",
"description": "The date and time the poll started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"endTime": {
"type": "string",
"example": "2021-07-06T09:28:34Z",
"description": "The date and time the poll ended in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"content": {
"type": "object",
"properties": {
"questionCount": {
"type": "number",
"example": 10,
"description": "The total number of questions."
},
"userCount": {
"type": "number",
"example": 10,
"description": "The total number of users."
},
"votedUserCount": {
"type": "number",
"example": 3,
"description": "The number of voters among users."
},
"questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchivePollQuestion"
},
"description": "Poll's questions."
}
},
"description": "The content of the meeting archive poll;"
}
}
},
"MeetingRecordingArchivePollQuestion": {
"type": "object",
"properties": {
"voteUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveUser"
},
"description": "The voters among users."
},
"question": {
"type": "object",
"properties": {
"choiceCount": {
"type": "number",
"example": 3,
"description": "The number of choices in the questions."
},
"type": {
"type": "string",
"example": "single",
"description": "The type of the question."
},
"text": {
"type": "string",
"example": "Do you like this API?",
"description": "The text of the question."
}
},
"description": "The poll's question."
},
"answerSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchivePollAnswerSummary"
},
"description": "The answer summary of the archive poll."
},
"respondents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchivePollRespondent"
},
"description": "The question's respondents."
}
}
},
"MeetingRecordingArchiveUser": {
"type": "object",
"properties": {
"correlationId": {
"type": "number",
"example": 28208023,
"description": "An internal ID that is associated with each join."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "Display name for the meeting participant."
},
"email": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting participant."
}
}
},
"MeetingRecordingArchivePollAnswerSummary": {
"type": "object",
"properties": {
"totalRespondents": {
"type": "number",
"example": 10,
"description": "The total number of people who selected this answer."
},
"isCorrect": {
"type": "boolean",
"example": true,
"description": "Whether the answer is correct."
},
"text": {
"type": "string",
"example": "Yes, I do.",
"description": "The text of the answer."
},
"voteUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveUser"
},
"description": "The voters among users."
}
}
},
"MeetingRecordingArchivePollRespondent": {
"type": "object",
"properties": {
"correlationId": {
"type": "number",
"example": 28208023,
"description": "An internal ID that is associated with the respondent's each join."
},
"displayName": {
"type": "string",
"example": "Alex Green",
"description": "Display name for the poll respondent."
},
"email": {
"type": "string",
"example": "alex.green@example.com",
"description": "Email address for the poll respondent."
},
"answers": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of answers to the question."
}
}
},
"MeetingRecordingArchiveQA": {
"type": "object",
"properties": {
"priority": {
"type": "string",
"example": "NA",
"description": "The priority of the Q and A."
},
"type": {
"type": "string",
"example": "private",
"description": "Whether the type of the Q and A is private, public, or group. Private Q and A is for the 1:1 chat. Public Q and A are for the message which is sent to all the people in the meeting. Group Q and A are for the message which is sent to a small group of people, like a Q and A to \"host and presenter\"."
},
"displayName": {
"type": "string",
"example": "john.andersen@example.com`",
"description": "The email of the user who asked the question."
},
"questionTime": {
"type": "string",
"example": "2021-07-06T09:22:34Z",
"description": "The date and time the question was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"target": {
"type": "string",
"example": "All Participants",
"description": "Information of the user who asked the question."
},
"question": {
"type": "string",
"example": "Are you ok?",
"description": "The question that was asked."
},
"answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveQAAnswer"
},
"description": "Question's answers."
}
}
},
"MeetingRecordingArchiveQAAnswer": {
"type": "object",
"properties": {
"responseMode": {
"type": "string",
"example": "private",
"description": "The answer's response mode."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "The name of the person who answered the question."
},
"correlationId": {
"type": "number",
"example": 10947662,
"description": "An internal ID that is associated with the answer's each join."
},
"email": {
"type": "string",
"example": "alex.green@example.com",
"description": "The email of the person who answered the question."
},
"answerTime": {
"type": "string",
"example": "2021-07-06T09:52:34Z",
"description": "The date and time the question answered in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"text": {
"type": "string",
"example": "Yes, I am.",
"description": "The text of the answer."
}
}
},
"MeetingRecordingArchiveSystemInfo": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "The name of the person who accessed the meeting archive."
},
"catalogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SystemInfoCatalog"
},
"description": "The catalogs of system information."
}
}
},
"SystemInfoCatalog": {
"type": "object",
"properties": {
"systemSummary": {
"type": "string",
"example": "User Name: John{*}Operating System: Mac OS X 12.6{*}User Home Directory: /Users/John{*}Date and Time: Tue Oct 18 10:38:17 CST 2022{*}",
"description": "System summary."
},
"browser": {
"type": "string",
"example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
"description": "The browser user agent of the person who acted."
},
"hardware": {
"type": "string",
"example": "mac book",
"description": "The type of hardware that the user used to attend the meeting."
},
"installedSoftware": {
"type": "string",
"example": "webex",
"description": "The software that the user used to attend the meeting."
},
"runningSoftware": {
"type": "string",
"example": "webex",
"description": "The software the user used that is running."
},
"startupPrograms": {
"type": "string",
"example": "Macintosh HD",
"description": "Startup Programs."
},
"storage": {
"type": "string",
"example": "16 GB 2667 MHz DDR4",
"description": "The storage information of the user's device."
},
"video": {
"type": "string",
"example": "AirPlay",
"description": "The video of the user's device."
},
"network": {
"type": "string",
"example": "Wi-Fi",
"description": "The network of the user's device."
},
"operatingSystem": {
"type": "string",
"example": "Mac OS X 10.0",
"description": "The operating system of the user's device."
},
"environmentVariables": {
"type": "string",
"example": "/usr/local/bin:$PATH",
"description": "The environment variables of the user's device."
},
"processes": {
"type": "string",
"example": "2.6 GHz 6-Core Intel Core i7",
"description": "The processes of the user's device."
},
"logicalDrives": {
"type": "string",
"example": "webapp",
"description": "The logical drives of the user's device."
},
"devices": {
"type": "string",
"example": "device1",
"description": "The device of the user."
},
"services": {
"type": "string",
"example": "Firewall",
"description": "The service of the user's device."
},
"systemDrivers": {
"type": "string",
"example": "32drivers",
"description": "The system driver of the user's device."
},
"signedDrivers": {
"type": "string",
"example": "32drivers",
"description": "The sign driver system of the user's device."
},
"eventViewer": {
"type": "string",
"example": "Screen Sharing",
"description": "The event viewer of the user's device."
},
"bios": {
"type": "string",
"example": "AwardBIOS",
"description": "The basic input and output system."
}
}
},
"RecordingObject": {
"type": "object",
"required": [
"id",
"meetingId",
"topic",
"createTime",
"timeRecorded",
"siteUrl",
"downloadUrl",
"playbackUrl",
"password",
"format",
"serviceType",
"durationSeconds",
"sizeBytes",
"shareToMe",
"status"
],
"properties": {
"id": {
"type": "string",
"example": "4f914b1dfe3c4d11a61730f18c0f5387",
"description": "A unique identifier for the recording."
},
"meetingId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"description": "Unique identifier for the recording's ended meeting instance."
},
"scheduledMeetingId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"description": "Unique identifier for the recording's scheduled meeting instance."
},
"meetingSeriesId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291",
"description": "Unique identifier for the recording's meeting series."
},
"topic": {
"type": "string",
"example": "John's Meeting",
"description": "The recording's topic."
},
"createTime": {
"type": "string",
"example": "2019-01-27T17:43:24Z",
"description": "The date and time recording was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. Please note that it's not the time the record button was clicked in meeting but the time the recording file was generated offline."
},
"timeRecorded": {
"type": "string",
"example": "2019-01-27T17:40:20Z",
"description": "The date and time recording started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. It indicates when the record button was clicked in the meeting."
},
"siteUrl": {
"type": "string",
"example": "site4-example.webex.com",
"description": "Site URL for the recording."
},
"downloadUrl": {
"type": "string",
"example": "https://site4-example.webex.com/site4/lsr.php?RCID=60b864cc80aa5b44fc9769c8305b98b7",
"description": "The download link for recording. This attribute is not available if **Prevent downloading** has been turned on for the recording being requested. The **Prevent downloading** option can be viewed and set by a site admin on [Control Hub](https://help.webex.com/en-us/article/sxdj4ab/Manage-Security-for-a-Cisco-Webex-Site-in-Cisco-Webex-Control-Hub)."
},
"playbackUrl": {
"type": "string",
"example": "https://site4-example.webex.com/site4/ldr.php?RCID=7a8a476b29a32cd1e06dfa6c81970f19",
"description": "The playback link for recording."
},
"password": {
"type": "string",
"example": "********",
"description": "The recording's password."
},
"format": {
"type": "string",
"enum": [
"MP4",
"ARF",
"UPLOADED"
],
"description": " * `MP4` - Recording file format is MP4.\n * `ARF` - Recording file format is ARF, a proprietary Webex recording format.\n * `UPLOADED` - The recording file is uploaded manually.\n"
},
"serviceType": {
"type": "string",
"enum": [
"MeetingCenter",
"EventCenter",
"TrainingCenter",
"SupportCenter"
],
"description": "The service type for the recording.\n * `MeetingCenter` - The service type for the recording is meeting.\n * `EventCenter` - The service type for the recording is the event.\n * `TrainingCenter` - The service type for the recording is the training session.\n * `SupportCenter` - The service type for the recording is the support meeting.\n"
},
"durationSeconds": {
"type": "number",
"example": 4472,
"description": "The duration of the recording, in seconds."
},
"sizeBytes": {
"type": "number",
"example": 248023188,
"description": "The size of the recording file, in bytes."
},
"shareToMe": {
"type": "boolean",
"description": "Whether or not the recording has been shared to the current user. This attribute is hidden if the user calling the API is a Compliance Officer and `hostEmail` is not specified."
},
"integrationTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "External keys of the parent meeting created by an integration application. They could be Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. The integration application queries recordings by a key in its own domain."
},
"status": {
"type": "string",
"enum": [
"available",
"deleted",
"purged"
],
"description": " * `available` - Recording is available.\n * `deleted` - Recording has been moved into recycle bin.\n * `purged` - Recording has been purged from the recycle bin. Only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.\n"
}
}
},
"RecordingObjectForAdminAndCO": {
"type": "object",
"required": [
"id",
"meetingId",
"topic",
"createTime",
"timeRecorded",
"hostDisplayName",
"hostEmail",
"siteUrl",
"downloadUrl",
"playbackUrl",
"format",
"serviceType",
"durationSeconds",
"sizeBytes",
"status"
],
"properties": {
"id": {
"type": "string",
"example": "4f914b1dfe3c4d11a61730f18c0f5387",
"description": "A unique identifier for the recording."
},
"meetingId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"description": "Unique identifier for the recording's ended meeting instance."
},
"scheduledMeetingId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"description": "Unique identifier for the recording's scheduled meeting instance."
},
"meetingSeriesId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291",
"description": "Unique identifier for the recording's meeting series."
},
"topic": {
"type": "string",
"example": "John's Meeting",
"description": "The recording's topic."
},
"createTime": {
"type": "string",
"example": "2019-01-27T17:43:24Z",
"description": "The date and time recording was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. Please note that it's not the time the record button was clicked in meeting but the time the recording file was generated offline."
},
"timeRecorded": {
"type": "string",
"example": "2019-01-27T17:40:20Z",
"description": "The date and time recording started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. It indicates when the record button was clicked in the meeting."
},
"hostDisplayName": {
"type": "string",
"example": "John Andersen",
"description": "Display name for the meeting host."
},
"hostEmail": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting host."
},
"siteUrl": {
"type": "string",
"example": "site4-example.webex.com",
"description": "Site URL for the recording."
},
"downloadUrl": {
"type": "string",
"example": "https://site4-example.webex.com/site4/lsr.php?RCID=60b864cc80aa5b44fc9769c8305b98b7",
"description": "The download link for recording. This attribute is not available if **Prevent downloading** has been turned on for the recording being requested. The **Prevent downloading** option can be viewed and set by a site admin on [Control Hub](https://help.webex.com/en-us/article/sxdj4ab/Manage-Security-for-a-Cisco-Webex-Site-in-Cisco-Webex-Control-Hub)."
},
"playbackUrl": {
"type": "string",
"example": "https://site4-example.webex.com/site4/ldr.php?RCID=7a8a476b29a32cd1e06dfa6c81970f19",
"description": "The playback link for recording."
},
"format": {
"type": "string",
"enum": [
"MP4",
"ARF",
"UPLOADED"
],
"description": " * `MP4` - Recording file format is MP4.\n * `ARF` - Recording file format is ARF, a proprietary Webex recording format.\n * `UPLOADED` - The recording file is uploaded manually.\n"
},
"serviceType": {
"type": "string",
"enum": [
"MeetingCenter",
"EventCenter",
"TrainingCenter",
"SupportCenter"
],
"description": "The service type for the recording.\n * `MeetingCenter` - The service type for the recording is meeting.\n * `EventCenter` - The service type for the recording is the event.\n * `TrainingCenter` - The service type for the recording is the training session.\n * `SupportCenter` - The service type for the recording is the support meeting.\n"
},
"durationSeconds": {
"type": "number",
"example": 4472,
"description": "The duration of the recording, in seconds."
},
"sizeBytes": {
"type": "number",
"example": 248023188,
"description": "The size of the recording file, in bytes."
},
"integrationTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "External keys of the parent meeting created by an integration application. They could be Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. The integration application queries recordings by a key in its own domain."
},
"status": {
"type": "string",
"enum": [
"available",
"deleted",
"purged"
],
"description": " * `available` - Recording is available.\n * `deleted` - Recording has been moved into recycle bin.\n * `purged` - Recording has been purged from the recycle bin. Please note that only a compliance officer can access recordings with a `purged` status.\n"
}
}
},
"RecordingObjectWithDirectDownloadLinks": {
"type": "object",
"required": [
"id",
"meetingId",
"topic",
"createTime",
"timeRecorded",
"siteUrl",
"downloadUrl",
"playbackUrl",
"password",
"format",
"serviceType",
"durationSeconds",
"sizeBytes",
"shareToMe",
"status"
],
"properties": {
"id": {
"type": "string",
"example": "7ee40776779243b4b3da448d941b34dc",
"description": "A unique identifier for recording."
},
"meetingId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"description": "Unique identifier for the recording's ended meeting instance."
},
"scheduledMeetingId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"description": "Unique identifier for the recording's scheduled meeting instance."
},
"meetingSeriesId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291",
"description": "Unique identifier for the recording's meeting series."
},
"topic": {
"type": "string",
"example": "John's Meeting",
"description": "The recording's topic."
},
"createTime": {
"type": "string",
"example": "2019-01-27T17:43:24Z",
"description": "The date and time recording was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. Please note that it's not the time the record button was clicked in meeting but the time the recording file was generated offline."
},
"timeRecorded": {
"type": "string",
"example": "2019-01-27T17:40:20Z",
"description": "The date and time recording started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. It indicates when the record button was clicked in the meeting."
},
"siteUrl": {
"type": "string",
"example": "site4-example.webex.com",
"description": "Site URL for the recording."
},
"downloadUrl": {
"type": "string",
"example": "https://site4-example.webex.com/site4/lsr.php?RCID=60b864cc80aa5b44fc9769c8305b98b7",
"description": "The download link for the recording. This attribute is not available if `prevent downloading` has been turned on for the recording being requested. The `prevent downloading` option can be viewed and set on page when editing a recording."
},
"playbackUrl": {
"type": "string",
"example": "https://site4-example.webex.com/site4/ldr.php?RCID=7a8a476b29a32cd1e06dfa6c81970f19",
"description": "The playback link for recording."
},
"password": {
"type": "string",
"example": "********",
"description": "The recording's password."
},
"format": {
"type": "string",
"enum": [
"MP4",
"ARF",
"UPLOADED"
],
"description": " * `MP4` - Recording file format is MP4.\n * `ARF` - Recording file format is ARF, a proprietary Webex recording format.\n * `UPLOADED` - The recording file is uploaded manually.\n"
},
"serviceType": {
"type": "string",
"enum": [
"MeetingCenter",
"EventCenter",
"TrainingCenter",
"SupportCenter"
],
"description": " * `MeetingCenter` - The service type for the recording is meeting.\n * `EventCenter` - The service type for the recording is the event.\n * `TrainingCenter` - The service type for the recording is the training session.\n * `SupportCenter` - The service type for the recording is the support meeting.\n"
},
"durationSeconds": {
"type": "number",
"example": 4472,
"description": "The duration of the recording in seconds."
},
"sizeBytes": {
"type": "number",
"example": 248023188,
"description": "The size of the recording file in bytes."
},
"shareToMe": {
"type": "boolean",
"description": "Whether or not the recording has been shared to the current user."
},
"temporaryDirectDownloadLinks": {
"type": "object",
"properties": {
"recordingDownloadLink": {
"type": "string",
"description": "The download link for recording MP4/ARF file without HTML page rendering in browser or HTTP redirect. Expires 3 hours after the API request."
},
"audioDownloadLink": {
"type": "string",
"description": "The download link for recording audio file without HTML page rendering in browser or HTTP redirect. This attribute is not available if **Prevent Downloading** has been turned on for the recording being requested. Expires 3 hours after the API request."
},
"transcriptDownloadLink": {
"type": "string",
"description": "The download link for recording transcript file without HTML page rendering in browser or HTTP redirect. This attribute is not available if **Prevent Downloading** has been turned on for the recording being requested. Expires 3 hours after the API request."
},
"expiration": {
"type": "string",
"description": "The date and time when `recordingDownloadLink`, `audioDownloadLink`, and `transcriptDownloadLink` expire in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
}
},
"description": "The download links for MP4/ARF, audio, and transcript of the recording without HTML page rendering in browser or HTTP redirect. This attribute is not available if the user is not a [Compliance Officer](/docs/compliance#compliance) and **Prevent Downloading** has been turned on for the recording being requested. The Prevent Downloading option can be viewed and set on page when editing a recording. Note that there are various products in [Webex Suite](https://www.cisco.com/c/en/us/products/conferencing/product_comparison.html) such as \"Webex Meetings\", \"Webex Training\" and \"Webex Events\"."
},
"integrationTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "External keys of the parent meeting created by an integration application. The key can be Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. The integration application queries recordings by a key in its own domain."
},
"status": {
"type": "string",
"enum": [
"available",
"deleted",
"purged"
],
"description": " * `available` - Recording is available.\n * `deleted` - Recording has been moved to the recycle bin.\n * `purged` - Recording has been purged from the recycle bin. Please note that only a compliance officer can access recordings with a `purged` status.\n"
}
}
},
"DeleteRecordingObject": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"example": "audit",
"description": "Reason for deleting a recording. Only required when a Compliance Officer is operating on another user's recording."
},
"comment": {
"type": "string",
"example": "Maintain data privacy",
"description": "Compliance Officer's explanation for deleting a recording. The comment can be a maximum of 255 characters long."
}
}
},
"BulkSoftDeleteRecordingObject": {
"type": "object",
"required": [
"recordingIds"
],
"properties": {
"recordingIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Recording IDs for removing recordings into the recycle bin in batch. Please note that all the recording IDs should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified."
},
"siteUrl": {
"type": "string",
"example": "example.webex.com",
"description": "URL of the Webex site from which the API deletes recordings. If not specified, the API deletes recordings from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API."
}
}
},
"BulkRestoreRecordingObject": {
"type": "object",
"properties": {
"restoreAll": {
"type": "boolean",
"description": "If not specified or `false`, restores the recordings specified by `recordingIds`. If `true`, restores all recordings from the recycle bin."
},
"recordingIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Recording IDs for recovering recordings from the recycle bin in batch. Note that all the recording IDs should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified."
},
"siteUrl": {
"type": "string",
"example": "example.webex.com",
"description": "URL of the Webex site from which the API restores recordings. If not specified, the API restores recordings from a user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API."
}
}
},
"BulkPurgeRecordingObject": {
"type": "object",
"properties": {
"purgeAll": {
"type": "boolean",
"description": "If not specified or `false`, purges the recordings specified by `recordingIds`. If `true`, purges all recordings from the recycle bin."
},
"recordingIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Recording IDs for purging recordings from the recycle bin in batch. Note that all the recording IDs should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified."
},
"siteUrl": {
"type": "string",
"example": "example.webex.com",
"description": "URL of the Webex site from which the API purges recordings. If not specified, the API purges recordings from user's preferred site. All available Webex sites and preferred sites of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API."
}
}
},
"ShareRecordingByIdObject": {
"type": "object",
"properties": {
"hostEmail": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin-level scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host. The field is not editable and is only used to share or unshare a recording on behalf of the real meeting host."
},
"addEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Email addresses of users to share the recording with. The maximum size of the array is `100`."
},
"removeEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Email addresses of users to unshare the recording with. The maximum size of the array is `100`."
},
"sendEmail": {
"type": "boolean",
"description": "Whether to send email notifications to the users being shared. The default is `true`."
}
}
},
"ShareRecordingByLinkObject": {
"type": "object",
"properties": {
"hostEmail": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin-level scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host. The field is not editable and is only used to share or unshare a recording link on behalf of the real meeting host."
},
"webShareLink": {
"type": "string",
"example": "https://example.webex.com/recordingservice/sites/example/recording/playback/1234567890abcdef1234567890abcdef",
"description": "The link for the recording to be shared or unshared."
},
"addEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Email addresses of users to share the recording link with. The maximum size of the array is `100`."
},
"removeEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Email addresses of users to unshare the recording link with. The maximum size of the array is `100`."
},
"sendEmail": {
"type": "boolean",
"description": "Whether to send email notifications to the users being shared. The default is `true`."
}
}
},
"Webhook": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1dFQkhPT0svOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"description": "A unique identifier for the webhook."
},
"name": {
"type": "string",
"example": "My Awesome Webhook",
"description": "A user-friendly name for the webhook."
},
"targetUrl": {
"type": "string",
"example": "https://example.com/mywebhook",
"description": "URL that receives POST requests for each event."
},
"resource": {
"type": "string",
"enum": [
"attachmentActions",
"dataSources",
"memberships",
"messages",
"rooms",
"meetings",
"recordings",
"convergedRecordings",
"meetingParticipants",
"meetingTranscripts",
"telephony_calls",
"telephony_conference",
"telephony_mwi",
"uc_counters",
"serviceApp",
"adminBatchJobs"
],
"description": "Resource type for the webhook. Creating a webhook requires 'read' scope on the resource the webhook is for.\n * `attachmentActions` - [Attachment Actions](/docs/api/v1/attachment-actions) resource.\n * `dataSources` - [data sources](/docs/api/v1/data-sources) resource.\n * `memberships` - [Memberships](/docs/api/v1/memberships) resource.\n * `messages` - [Messages](/docs/api/v1/messages) resource.\n * `rooms` - [Rooms](/docs/api/v1/rooms) resource.\n * `meetings` - [Meetings](/docs/api/v1/meetings) resource.\n * `recordings` - [Recordings](/docs/api/v1/recordings) resource.\n * `convergedRecordings` - [CallRecordings](/docs/api/v1/converged-recordings) resource.\n * `meetingParticipants` - [Meeting Participants](/docs/api/v1/meeting-participants) resource.\n * `meetingTranscripts` - [Meeting Transcripts](/docs/api/v1/meeting-transcripts) resource.\n * `telephony_calls` - [Webex Calling](/docs/webex-calling-overview) call resources.\n * `telephony_conference` - [Webex Calling](/docs/webex-calling-overview) conference controls resource.\n * `telephony_mwi` - [Webex Calling](/docs/webex-calling-overview) voicemail message waiting indicator resource.\n * `uc_counters` - Performance counter for a dedicated instance.\n * `serviceApp` - Service App authorization notification.\n * `adminBatchJobs` - Admin Batch Jobs notification.\n"
},
"event": {
"type": "string",
"enum": [
"created",
"updated",
"deleted",
"started",
"ended",
"joined",
"left",
"migrated",
"authorized",
"deauthorized",
"statusChanged"
],
"description": "Event type for the webhook.\n * `created` - An object was created.\n * `updated` - An object was updated.\n * `deleted` - An object was deleted.\n * `started` - A meeting was started.\n * `ended` - A meeting was ended.\n * `joined` - A participant joined.\n * `left` - A participant left.\n * `migrated` - A room was migrated to a different geography. The roomId has changed.\n * `authorized` - A Service App was authorized.\n * `deauthorized` - A Service App was deauthorized.\n * `statusChanged` - Status of admin batch job was changed.\n"
},
"filter": {
"type": "string",
"example": "roomId=Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
"description": "Filter that defines the webhook scope."
},
"secret": {
"type": "string",
"example": "86dacc007724d8ea666f88fc77d918dad9537a15",
"description": "Secret used to generate payload signature."
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
],
"description": "Status of the webhook. Use `active` to reactivate a disabled webhook.\n * `active` - Webhook is active.\n * `inactive` - Webhook is inactive.\n"
},
"created": {
"type": "string",
"example": "2015-10-18T14:26:16+00:00",
"description": "Date and time the webhook was created."
},
"ownedBy": {
"type": "string",
"example": "org",
"description": "Specify `org` when creating an org/admin level webhook. Supported for `meetings`, `recordings`, `convergedRecordings`, `meetingParticipants`, `meetingTranscripts`, `videoMeshAlerts`, `controlHubAlerts`, `rooms`, `messaging` and `adminBatchJobs` (for Compliance Officers and messages with file attachments only - see [inline file DLP](/docs/api/guides/webex-real-time-file-dlp-basics)) resources."
}
}
},
"WebhookCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
}
}
}
},
"WorkspaceLocationsCreationRequest": {
"type": "object",
"required": [
"displayName",
"address",
"countryCode",
"latitude",
"longitude"
],
"properties": {
"displayName": {
"type": "string",
"example": "Cisco Barcelona",
"description": "A friendly name for the location."
},
"address": {
"type": "string",
"example": "Carrer de Pere IV, Barcelona, Spain",
"description": "The location address."
},
"countryCode": {
"type": "string",
"example": "ES",
"description": "The location country code (ISO 3166-1)."
},
"cityName": {
"type": "string",
"example": "Barcelona",
"description": "The location city name."
},
"latitude": {
"type": "number",
"example": 41.406615,
"description": "The location latitude."
},
"longitude": {
"type": "number",
"example": 2.200717,
"description": "The location longitude."
},
"notes": {
"type": "string",
"example": "A note about the location",
"description": "Notes associated with the location."
}
}
},
"WorkspaceLocationsUpdateRequest": {
"type": "object",
"required": [
"displayName",
"address",
"countryCode",
"latitude",
"longitude"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"description": "Unique identifier for the location."
},
"displayName": {
"type": "string",
"example": "Cisco Barcelona",
"description": "A friendly name for the location."
},
"address": {
"type": "string",
"example": "Carrer de Pere IV, Barcelona, Spain",
"description": "The location address."
},
"countryCode": {
"type": "string",
"example": "ES",
"description": "The location country code (ISO 3166-1)."
},
"cityName": {
"type": "string",
"example": "Barcelona",
"description": "The location city name."
},
"latitude": {
"type": "number",
"example": 41.406615,
"description": "The location latitude."
},
"longitude": {
"type": "number",
"example": 2.200717,
"description": "The location longitude."
},
"notes": {
"type": "string",
"example": "A note about the location",
"description": "Notes associated with the location."
}
}
},
"WorkspaceLocationsCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
},
"description": "An array of location objects."
}
}
},
"WorkspaceLocationFloorsCreationRequest": {
"type": "object",
"required": [
"floorNumber"
],
"properties": {
"floorNumber": {
"type": "number",
"example": -1,
"description": "The floor number."
},
"displayName": {
"type": "string",
"example": "The basement",
"description": "The floor display name."
}
}
},
"WorkspaceLocationFloorsUpdateRequest": {
"type": "object",
"required": [
"floorNumber"
],
"properties": {
"floorNumber": {
"type": "number",
"example": 1,
"description": "The floor number."
},
"displayName": {
"type": "string",
"example": "My custom name",
"description": "The floor display name."
}
}
},
"WorkspaceLocationFloorsCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Floor"
},
"description": "An array of floor objects."
}
}
},
"WorkspaceMetricsResponse": {
"type": "object",
"required": [
"workspaceId",
"metricName"
],
"properties": {
"workspaceId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE"
},
"metricName": {
"type": "string",
"enum": [
"soundLevel",
"ambientNoise",
"temperature",
"humidity",
"tvoc",
"peopleCount"
]
},
"aggregation": {
"type": "string",
"enum": [
"none",
"hourly",
"daily"
]
},
"from": {
"type": "string",
"example": "2020-10-21T13:33:37.789Z"
},
"to": {
"type": "string",
"example": "2020-10-31T16:00:00.532Z"
},
"unit": {
"type": "string",
"enum": [
"celsius",
"fahrenheit"
],
"description": "Output data unit (only present if `metricName` is `temperature`)."
},
"sortBy": {
"type": "string",
"enum": [
"newestFirst",
"oldestFirst"
]
},
"items": {
"type": "array",
"items": {},
"description": "The structure of the elements will depend on whether or not aggregated data was requested"
}
}
},
"DurationMetric": {
"type": "object",
"properties": {
"start": {
"type": "string",
"example": "2021-10-21T12:00:00Z",
"description": "Timestamp indicating the start of the aggregation bucket (ISO 8601)."
},
"end": {
"type": "string",
"example": "2021-10-21T13:00:00Z",
"description": "Timestamp indicating the end of the aggregation bucket (ISO 8601)."
},
"duration": {
"type": "number",
"example": 13,
"description": "The time duration (in a given state) in the bucket."
}
}
},
"WorkspaceDurationMetricsResponse": {
"type": "object",
"required": [
"workspaceId"
],
"properties": {
"workspaceId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE"
},
"aggregation": {
"type": "string",
"enum": [
"hourly",
"daily"
]
},
"measurement": {
"type": "string",
"enum": [
"timeUsed",
"timeBooked"
]
},
"from": {
"type": "string",
"example": "2020-10-21T13:33:37.789Z"
},
"to": {
"type": "string",
"example": "2020-10-31T16:00:00.532Z"
},
"unit": {
"type": "string",
"example": "minutes",
"description": "The time unit."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DurationMetric"
}
}
}
},
"WorkspaceIssue": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Issue id."
},
"createdAt": {
"type": "string",
"description": "Issue created timestamp."
},
"title": {
"type": "string",
"description": "Issue title."
},
"description": {
"type": "string",
"description": "Issue description."
},
"recommendedAction": {
"type": "string",
"description": "Recommended action to mitigate issue."
},
"level": {
"type": "object",
"properties": {
"Members": {
"type": "string",
"enum": [
"error",
"warning",
"info"
]
}
},
"description": "Issue level."
}
}
},
"Workspace": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc",
"description": "Unique identifier for the Workspace."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
"description": "`OrgId` associated with the workspace."
},
"locationId": {
"type": "string",
"example": "Y2lzY29...",
"description": "Location associated with the workspace (ID to use for the [/locations API](/docs/api/v1/locations))."
},
"workspaceLocationId": {
"type": "string",
"example": "YL34GrT...",
"description": "Legacy workspace location ID associated with the workspace. Prefer `locationId`."
},
"floorId": {
"type": "string",
"example": "Y2lzY29z...",
"description": "Floor associated with the workspace."
},
"displayName": {
"type": "string",
"example": "SFO-12 Capanina",
"description": "A friendly name for the workspace."
},
"capacity": {
"type": "number",
"example": 5,
"description": "How many people the workspace is suitable for."
},
"type": {
"type": "string",
"enum": [
"notSet",
"focus",
"huddle",
"meetingRoom",
"open",
"desk",
"other"
],
"description": "The workspace type.\n * `notSet` - No workspace type set.\n * `focus` - High concentration.\n * `huddle` - Brainstorm/collaboration.\n * `meetingRoom` - Dedicated meeting space.\n * `open` - Unstructured agile.\n * `desk` - Individual.\n * `other` - Unspecified.\n"
},
"sipAddress": {
"type": "string",
"example": "test_workspace_1@trialorg.room.ciscospark.com",
"description": "`SipUrl` to call all the devices associated with the workspace."
},
"created": {
"type": "string",
"example": "2016-04-21T17:00:00.000Z",
"description": "The date and time that the workspace was registered, in ISO8601 format."
},
"calling": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"freeCalling",
"hybridCalling",
"webexCalling",
"webexEdgeForDevices",
"thirdPartySipCalling",
"none"
],
"description": "Calling.\n * `freeCalling` - Free Calling.\n * `hybridCalling` - Hybrid Calling.\n * `webexCalling` - Webex Calling.\n * `webexEdgeForDevices` - Webex Edge For Devices.\n * `thirdPartySipCalling` - Third-party SIP URI.\n * `none` - No Calling.\n"
},
"hybridCalling": {
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"example": "workspace@example.com",
"description": "End user email address in Cisco Unified CM."
}
},
"description": "The `hybridCalling` object only applies when calling type is `hybridCalling`."
},
"webexCalling": {
"type": "object",
"properties": {
"licenses": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29g4..."
},
"description": "The Webex Calling license associated with this workspace."
}
},
"description": "The `webexCalling` object only applies when calling type is `webexCalling`."
}
},
"description": "Calling type."
},
"calendar": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"none",
"google",
"microsoft"
],
"description": " * `none` - No calendar.\n * `google` - Google Calendar.\n * `microsoft` - Microsoft Exchange or Office 365.\n"
},
"emailAddress": {
"type": "string",
"example": "workspace@example.com",
"description": "Workspace email address. Will not be set when the calendar type is `none`."
}
},
"description": "Calendar type. Calendar of type `none` does not include an `emailAddress` field."
},
"notes": {
"type": "string",
"example": "this is a note",
"description": "Notes associated to the workspace."
},
"hotdeskingStatus": {
"type": "string",
"enum": [
"on",
"off"
],
"description": "Hot desking status of the workspace.\n * `on` - Workspace supports hotdesking.\n * `off` - Workspace does not support hotdesking.\n"
},
"supportedDevices": {
"type": "string",
"enum": [
"collaborationDevices",
"phones"
],
"description": "The supported devices for the workspace. Default is `collaborationDevices`.\n * `collaborationDevices` - Workspace supports collaboration devices.\n * `phones` - Workspace supports MPP phones.\n"
},
"deviceHostedMeetings": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "`true` if enabled or `false` otherwise."
},
"siteUrl": {
"type": "string",
"example": "'example.webex.com'",
"description": "The Webex site for the device hosting meetings."
}
},
"description": "Device hosted meetings configuration."
},
"devicePlatform": {
"type": "string",
"enum": [
"cisco",
"microsoftTeamsRoom"
],
"description": "The device platform.\n * `cisco` - Cisco.\n * `microsoftTeamsRoom` - Microsoft Teams Room.\n"
},
"indoorNavigation": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL of a map locating the workspace."
}
},
"description": "Indoor navigation configuration."
},
"health": {
"type": "object",
"properties": {
"level": {
"type": "string",
"enum": [
"error",
"warning",
"info",
"ok"
],
"description": "Health level. The level is based on the list of issues associated with the workspace."
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkspaceIssue"
},
"description": "A list of workspace issues."
}
},
"description": "The health of the workspace."
},
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Device"
},
"description": "A list of devices associated with the workspace."
},
"capabilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CapabilityMap"
},
"description": "The map of workspace capabilities."
},
"plannedMaintenance": {
"type": "object",
"description": "The planned maintenance for the workspace.",
"properties": {
"mode": {
"type": "string",
"enum": [
"off",
"on",
"upcoming"
],
"description": "The planned maintenance mode for the workspace"
},
"startTime": {
"type": "string",
"example": "2026-10-01T00:00:00.000Z",
"description": "The start of the planned maintenance period."
},
"endTime": {
"type": "string",
"example": "2026-10-02T00:00:00.000Z",
"description": "The end of the planned maintenance period."
}
}
}
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
"locationId": "YL34GrT...",
"workspaceLocationId": "YL34GrT...",
"floorId": "Y2lzY29z...",
"displayName": "SFO-12 Capanina",
"capacity": 5,
"sipAddress": ""
}
},
"WorkspaceCreationRequest": {
"type": "object",
"required": [
"displayName"
],
"properties": {
"displayName": {
"type": "string",
"example": "SFO-12 Capanina",
"description": "A friendly name for the workspace."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
"description": "`OrgId` associated with the workspace. Only admin users of another organization (such as partners) may use this parameter."
},
"locationId": {
"type": "string",
"example": "YL34GrT...",
"description": "Location associated with the workspace. Must be provided when the `floorId` is set."
},
"workspaceLocationId": {
"type": "string",
"example": "YL34GrT...",
"description": "Legacy workspace location ID associated with the workspace. Prefer `locationId`."
},
"floorId": {
"type": "string",
"example": "Y2lzY29z...",
"description": "Floor associated with the workspace."
},
"capacity": {
"type": "number",
"example": 5,
"description": "How many people the workspace is suitable for. If set, must be 0 or higher."
},
"type": {
"type": "string",
"enum": [
"notSet",
"focus",
"huddle",
"meetingRoom",
"open",
"desk",
"other"
],
"description": "The type that best describes the workspace.\n * `notSet` - No workspace type set.\n * `focus` - High concentration.\n * `huddle` - Brainstorm/collaboration.\n * `meetingRoom` - Dedicated meeting space.\n * `open` - Unstructured agile.\n * `desk` - Individual.\n * `other` - Unspecified.\n"
},
"sipAddress": {
"type": "string",
"description": "The `sipAddress` field can only be provided when calling type is `thirdPartySipCalling`."
},
"calling": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"freeCalling",
"hybridCalling",
"webexCalling",
"webexEdgeForDevices",
"thirdPartySipCalling",
"none"
],
"description": "The calling type that is supported on the workspace.\n * `freeCalling` - Free Calling (Default).\n * `hybridCalling` - Hybrid Calling.\n * `webexCalling` - Webex Calling.\n * `webexEdgeForDevices` - Webex Edge For Devices.\n * `thirdPartySipCalling` - Third-party SIP URI.\n * `none` - No Calling.\n"
},
"webexCalling": {
"type": "object",
"properties": {
"phoneNumber": {
"type": "string",
"example": "+12145654032",
"description": "End user phone number."
},
"extension": {
"type": "string",
"example": "28278",
"description": "End user extension."
},
"locationId": {
"type": "string",
"example": "Y2lzY29g4...",
"description": "Calling location ID."
},
"licenses": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29g4...1,Y2lzY29g4...2,Y2lzY29g4...n"
},
"description": "A list of Webex Calling License IDs. If multiple license IDs are provided, the oldest suitable one will be applied."
}
},
"description": "The `webexCalling` object only applies when calling type is `webexCalling`."
}
},
"description": "Calling."
},
"calendar": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "microsoft"
},
"emailAddress": {
"type": "string",
"example": "workspace@example.com",
"description": "Workspace email address. Will not be set when the calendar type is `none`."
},
"resourceGroupId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOk5vcndheS9SRVNPVVJDRV9HUk9VUC9jOGFiMDJhNC01NjI5LTRiNTctOGUyNy03ZDZkZjJlN2YzNzA=",
"description": "The `ResourceGroup` ID is associated with the workspace and is only applicable for on-premise MICROSOFT calendar."
}
},
"description": "Workspace calendar configuration requires a `type` (`microsoft`, `google`, or `none`), an `emailAddress`, and a `resourceGroupId`. The default is `none`."
},
"notes": {
"type": "string",
"example": "this is a note",
"description": "Notes associated to the workspace."
},
"hotdeskingStatus": {
"type": "string",
"enum": [
"on",
"off"
],
"description": "Hot desking status of the workspace.\n * `on` - Workspace supports hotdesking.\n * `off` - Workspace does not support hotdesking.\n"
},
"deviceHostedMeetings": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Set to `true` to enable or `false` to disable."
},
"siteUrl": {
"type": "string",
"example": "'example.webex.com'",
"description": "The Webex site for device hosting meetings."
}
},
"description": "To enable device hosted meetings, set a Webex `siteUrl` and the `enabled` flag to `true`."
},
"supportedDevices": {
"type": "string",
"enum": [
"collaborationDevices",
"phones"
],
"description": "The supported devices for the workspace. Default is `collaborationDevices`.\n * `collaborationDevices` - Workspace supports collaboration devices.\n * `phones` - Workspace supports MPP phones.\n"
},
"indoorNavigation": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL of a map locating the workspace."
}
},
"description": "Indoor navigation configuration."
}
}
},
"WorkspaceUpdateRequest": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"example": "SFO-12 Capanina",
"description": "A friendly name for the workspace."
},
"locationId": {
"type": "string",
"example": "YL34GrT...",
"description": "Location associated with the workspace. Must be provided when the `floorId` is set."
},
"workspaceLocationId": {
"type": "string",
"example": "YL34GrT...",
"description": "Legacy workspace location ID associated with the workspace. Prefer `locationId`."
},
"floorId": {
"type": "string",
"example": "Y2lzY29z...",
"description": "Floor associated with the workspace."
},
"capacity": {
"type": "number",
"example": 5,
"description": "How many people the workspace is suitable for. If set, must be 0 or higher."
},
"type": {
"type": "string",
"enum": [
"notSet",
"focus",
"huddle",
"meetingRoom",
"open",
"desk",
"other"
],
"description": "The type that best describes the workspace.\n * `notSet` - No workspace type set.\n * `focus` - High concentration.\n * `huddle` - Brainstorm/collaboration.\n * `meetingRoom` - Dedicated meeting space.\n * `open` - Unstructured agile.\n * `desk` - Individual.\n * `other` - Unspecified.\n"
},
"calendar": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "microsoft"
},
"emailAddress": {
"type": "string",
"example": "workspace@example.com",
"description": "Workspace email address. Will not be set when the calendar type is `none`."
},
"resourceGroupId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOk5vcndheS9SRVNPVVJDRV9HUk9VUC9jOGFiMDJhNC01NjI5LTRiNTctOGUyNy03ZDZkZjJlN2YzNzA=",
"description": "The `ResourceGroup` ID is associated with the workspace and is only applicable for on-premise MICROSOFT calendar."
}
},
"description": "An empty or null `calendar` field will not cause any changes. Provide a `type` (`microsoft`, `google`, or `none`), an `emailAddress`, and a `resourceGroupId`. To remove a calendar, set the `type` to `none`; this does not require an `emailAddress` or `resourceGroupId`."
},
"sipAddress": {
"type": "string",
"description": "The `sipAddress` field can only be provided when calling type is `thirdPartySipCalling`."
},
"calling": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"freeCalling",
"hybridCalling",
"webexCalling",
"webexEdgeForDevices",
"thirdPartySipCalling",
"none"
],
"description": "The calling type that is supported on the workspace.\n * `freeCalling` - Free Calling (Default).\n * `hybridCalling` - Hybrid Calling.\n * `webexCalling` - Webex Calling.\n * `webexEdgeForDevices` - Webex Edge For Devices.\n * `thirdPartySipCalling` - Third-party SIP URI.\n * `none` - No Calling.\n"
},
"webexCalling": {
"type": "object",
"properties": {
"phoneNumber": {
"type": "string",
"example": "+12145654032",
"description": "End user phone number."
},
"extension": {
"type": "string",
"example": "28278",
"description": "End user extension."
},
"locationId": {
"type": "string",
"example": "Y2lzY29g4...",
"description": "Calling location ID."
},
"licenses": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29g4...1,Y2lzY29g4...2,Y2lzY29g4...n"
},
"description": "A list of Webex Calling license IDs. If multiple license IDs are provided, the oldest suitable one will be applied."
}
},
"description": "The `webexCalling` object only applies when calling type is `webexCalling`."
}
},
"description": "Calling types supported on update are `freeCalling`, `thirdPartySipCalling`, `webexCalling` and `none`."
},
"notes": {
"type": "string",
"example": "this is a note",
"description": "Notes associated to the workspace."
},
"hotdeskingStatus": {
"type": "string",
"enum": [
"on",
"off"
],
"description": "Hot desking status of the workspace.\n * `on` - Workspace supports hotdesking.\n * `off` - Workspace does not support hotdesking.\n"
},
"deviceHostedMeetings": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Set to `true` to enable or `false` to disable."
},
"siteUrl": {
"type": "string",
"example": "'example.webex.com'",
"description": "The Webex site for device hosting meetings."
}
},
"description": "To enable device hosted meetings, set a Webex `siteUrl` and the `enabled` flag to `true`."
},
"indoorNavigation": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL of a map locating the workspace. Passing `null` will remove the configuration."
}
},
"description": "Indoor navigation configuration."
}
}
},
"WorkspaceCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Workspace"
},
"description": "An array of workspace objects."
}
},
"example": {
"items": []
}
},
"CapabilityResponse": {
"type": "object",
"example": {
"capabilities": {
"occupancyDetection": {
"supported": true,
"configured": true
},
"presenceDetection": {
"supported": true,
"configured": true
},
"ambientNoise": {
"supported": true,
"configured": true
},
"soundLevel": {
"supported": true,
"configured": true
},
"temperature": {
"supported": true,
"configured": true
},
"airQuality": {
"supported": true,
"configured": true
},
"relativeHumidity": {
"supported": true,
"configured": true
}
}
},
"properties": {
"capabilities": {
"$ref": "#/components/schemas/CapabilityMap"
}
}
},
"CapabilityMap": {
"type": "object",
"description": "The map of workspace capabilities.",
"example": {
"occupancyDetection": {
"supported": true,
"configured": true
},
"presenceDetection": {
"supported": true,
"configured": true
},
"ambientNoise": {
"supported": true,
"configured": true
},
"soundLevel": {
"supported": true,
"configured": true
},
"temperature": {
"supported": true,
"configured": true
},
"airQuality": {
"supported": true,
"configured": true
},
"relativeHumidity": {
"supported": true,
"configured": true
}
},
"properties": {
"occupancyDetection": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
},
"presenceDetection": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
},
"ambientNoise": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
},
"soundLevel": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
},
"temperature": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
},
"airQuality": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
},
"relativeHumidity": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
}
}
},
"SupportAndConfiguredInfo": {
"type": "object",
"properties": {
"supported": {
"type": "boolean",
"example": true,
"description": "Is the workspace capability supported or not."
},
"configured": {
"type": "boolean",
"example": true,
"description": "Is the workspace capability configured or not."
}
},
"description": "Support and configured information for a workspace capability.",
"example": {
"supported": true,
"configured": true
}
},
"AuditEventCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditEvent"
},
"description": "An array of audit event objects. See [this article](https://help.webex.com/n3b0w6x/) for details about each event type."
}
}
},
"AdminRolesEnum": {
"type": "string",
"enum": [
"User",
"Full_Admin",
"id_full_admin"
]
},
"AuditEvent": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"actorOrgName": {
"type": "string",
"example": "Acme Inc.",
"description": "The display name of the organization."
},
"targetName": {
"type": "string",
"example": "Acme Inc.",
"description": "The name of the resource being acted upon."
},
"eventDescription": {
"type": "string",
"example": "An Admin logged in",
"description": "A description for the event."
},
"actorName": {
"type": "string",
"example": "Joe Smith",
"description": "The name of the person who performed the action."
},
"actorEmail": {
"type": "string",
"example": "joe@example.com",
"description": "The email of the person who performed the action."
},
"adminRoles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdminRolesEnum"
},
"description": "Admin roles for the person."
},
"trackingId": {
"type": "string",
"example": "ATLAS_6f23a878-bcd4-c204-a4db-e701b42b0e5c_0",
"description": "A tracking identifier for the event."
},
"targetType": {
"type": "string",
"example": "TargetResourceType.ORG",
"description": "The type of resource changed by the event."
},
"targetId": {
"type": "string",
"example": "NWIzZTBiZDgtZjg4Ni00MjViLWIzMTgtYWNlYjliN2EwZGFj",
"description": "The identifier for the resource changed by the event."
},
"eventCategory": {
"type": "string",
"example": "EventCategory.LOGINS",
"description": "The category of resource changed by the event."
},
"actorUserAgent": {
"type": "string",
"example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
"description": "The browser user agent of the person who performed the action."
},
"actorIp": {
"type": "string",
"example": "128.107.241.191",
"description": "The IP address of the person who performed the action."
},
"targetOrgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The `orgId` of the organization."
},
"actionText": {
"type": "string",
"example": "Joe Smith logged into organization Acme Inc.",
"description": "A more detailed description of the change made by the person."
},
"targetOrgName": {
"type": "string",
"example": "Acme Inc.",
"description": "The name of the organization being acted upon."
},
"errorMessage": {
"type": "string",
"example": "WXC-25058 Extension cannot be less than 2 or greater than 6 characters",
"description": "User operation failure message."
},
"errorCode": {
"type": "string",
"example": "WXC-25058",
"description": "User operation failure code."
}
}
},
"created": {
"type": "string",
"example": "2019-01-02T16:58:36.845Z",
"description": "The date and time the event took place."
},
"actorOrgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The `orgId` of the person who made the change."
},
"id": {
"type": "string",
"example": "MjQ0ODhiZTYtY2FiMS00ZGRkLTk0NWQtZDFlYjkzOGQ4NGUy",
"description": "A unique identifier for the event."
},
"actorId": {
"type": "string",
"example": "MjQ4Njg2OTYtYWMwZC00ODY4LWJkMjEtZGUxZDc4MzhjOTdm",
"description": "The `personId` of the person who made the change."
}
}
},
"AuditEventCategoryCollectionResponse": {
"type": "object",
"properties": {
"eventCategories": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of audit event categories."
}
}
},
"Authorization": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0FVVEhPUklaQVRJT04vZjI3MDM0ZTMtMDA5ZS00ODA4LTk5MDQtNTNkMDQ0OGJlNDVk",
"description": "The unique authorization identifier."
},
"applicationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OL0NmMzkyNWU5NDFmMzhhYTc0M2Y0MmFiNzcwZmZhZjFhNTIyMjcxZDI5OTQ4NDhjNjk2YWMwYTEwN2Q2YTg5MjI3",
"description": "The unique identifier for the application."
},
"applicationName": {
"type": "string",
"example": "Developer Portal",
"description": "The name of the Integration."
},
"personId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lYjIyYjNiZC03NGNiLTRjMjktYjA3Zi1lYWQwMmU1NjgyZDI",
"description": "The person Id of the user. Can be used in the /people API."
},
"clientId": {
"type": "string",
"example": "C80fb9c7096bd8474627317ee1d7a817eff372ca9c9cee3ce43c3ea3e8d1511ec",
"description": "The unique oAuth client id."
},
"created": {
"type": "string",
"example": "2015-10-18T14:26:16+00:00",
"description": "The date and time the authorization was created."
},
"type": {
"type": "string",
"enum": [
"refresh",
"access"
],
"description": "The type of token associated with the authorization.\n * `refresh` - refresh authorization used to create `access` tokens\n * `access` - `access` token authorization\n"
}
}
},
"Authorizations Collection Response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Authorization"
}
}
}
},
"ListAuthorizations": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Authorization"
}
}
}
},
"OrganizationsSpaceClassificationCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HydraClassification"
}
}
}
},
"HydraClassification": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0NMQVNTSUZJQ0FUSU9OL2YyMDUyZTgyLTU0ZjgtMTFlYS1hMmUzLTJlNzI4Y2U4ODEyNQ",
"description": "Unique identifier for the org's Space Classification"
},
"rank": {
"type": "number",
"description": "Represents the rank of the classification. A number from 0 to 4, in which 0 usually refers to \"public\", and is the default whenever a rank cannot be determined."
},
"title": {
"type": "string",
"example": "Public",
"description": "Represents the classification title to be displayed in classified spaces for org users."
},
"enabled": {
"type": "boolean",
"example": true,
"description": "Space Classification enabled state."
},
"description": {
"type": "string",
"example": "Does not contain private information",
"description": "Classification's description."
},
"lastModified": {
"type": "string",
"example": "2020-02-22T00:06:42.438Z",
"description": "The date and time the Space Classification was last changed."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "A unique identifier for the Webex organization."
}
}
},
"CustomerGroupRequest": {
"type": "object",
"required": [
"schemas",
"displayName"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of schema URNs. Must contain 'urn:scim:schemas:core:1.0' and 'urn:scim:schemas:extension:cisco:commonidentity:1.0'.",
"example": [
"urn:scim:schemas:core:1.0",
"urn:scim:schemas:extension:cisco:commonidentity:1.0"
]
},
"displayName": {
"type": "string",
"description": "A human readable name for the Customer Group. Must be unique per org. Maximum length: 256 characters.",
"maxLength": 256,
"example": "customerGroup09-101"
},
"description": {
"type": "string",
"description": "Description of the group.",
"maxLength": 512,
"example": "Customer Group For PA63"
},
"members": {
"type": "array",
"description": "A list of customer organizations to be added to the group. Max 100 members per creation request.",
"items": {
"$ref": "#/components/schemas/Member"
}
},
"managedBy": {
"type": "array",
"description": "Administrators of customer groups.",
"items": {
"$ref": "#/components/schemas/ManagedBy"
}
}
}
},
"CustomerGroupPatchRequest": {
"type": "object",
"required": [
"schemas"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of schema URNs. Must contain 'urn:scim:schemas:core:1.0'.",
"example": [
"urn:scim:schemas:core:1.0",
"urn:scim:schemas:extension:cisco:commonidentity:1.0"
]
},
"meta": {
"type": "object",
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of attributes to be removed from the Resource."
}
}
},
"displayName": {
"type": "string",
"description": "A human readable name for the Customer Group. Maximum length: 256 characters.",
"maxLength": 256
},
"members": {
"type": "array",
"description": "A list of members to be added or removed.",
"items": {
"$ref": "#/components/schemas/PatchMember"
},
"minItems": 1
},
"managedBy": {
"type": "array",
"description": "Administrators of customer groups to be added or removed.",
"items": {
"$ref": "#/components/schemas/PatchManagedBy"
},
"minItems": 1
}
}
},
"CustomerGroupResponse": {
"type": "object",
"required": [
"schemas",
"id",
"meta",
"displayName",
"memberSize"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of schema URNs.",
"example": [
"urn:scim:schemas:core:1.0",
"urn:scim:schemas:extension:cisco:commonidentity:1.0"
]
},
"id": {
"type": "string",
"description": "Unique Customer Group Id.",
"example": "230898d8-f528-432f-93db-d138fa7fb20c"
},
"meta": {
"$ref": "#/components/schemas/GroupMeta"
},
"displayName": {
"type": "string",
"description": "A human readable name for the Customer Group.",
"example": "customerGroup09-101"
},
"description": {
"type": "string",
"description": "Description of the group.",
"example": "Customer Group For PA63"
},
"cisSyncSource": {
"type": "string",
"description": "Sync Source.",
"enum": [
"SCIM",
"DIRSYNC"
],
"example": "SCIM"
},
"memberSize": {
"type": "integer",
"description": "Number of members in the group.",
"example": 1
},
"members": {
"type": "array",
"description": "A list of members of the Group. Maximum of 500 members will be shown.",
"items": {
"$ref": "#/components/schemas/MemberResponse"
}
},
"managedBy": {
"type": "array",
"description": "Administrators of customer groups.",
"items": {
"$ref": "#/components/schemas/ManagedBy"
}
}
}
},
"ManagedByResponse": {
"type": "object",
"properties": {
"orgId": {
"type": "string",
"description": "The admin's organization ID.",
"example": "09ebb769-3098-4446-9093-4b39b296602b"
},
"type": {
"type": "string",
"description": "Type of administrator.",
"enum": [
"user"
],
"example": "user"
},
"id": {
"type": "string",
"description": "Entryuuid of the user.",
"example": "cb092233-b3e6-48fd-ab42-551f8cb01513"
},
"roles": {
"type": "array",
"description": "The roles assigned to the admin for managing the customer group.",
"items": {
"type": "string"
}
}
}
},
"CustomerGroupPostPatchResponse": {
"type": "object",
"required": [
"schemas",
"id",
"meta",
"displayName",
"memberSize"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of schema URNs.",
"example": [
"urn:scim:schemas:core:1.0",
"urn:scim:schemas:extension:cisco:commonidentity:1.0"
]
},
"id": {
"type": "string",
"description": "Unique Customer Group Id.",
"example": "230898d8-f528-432f-93db-d138fa7fb20c"
},
"meta": {
"$ref": "#/components/schemas/GroupMeta"
},
"displayName": {
"type": "string",
"description": "A human readable name for the Customer Group.",
"example": "customerGroup09-101"
},
"description": {
"type": "string",
"description": "Description of the group.",
"example": "Customer Group For PA63"
},
"cisSyncSource": {
"type": "string",
"description": "Sync Source.",
"enum": [
"SCIM",
"DIRSYNC"
],
"example": "SCIM"
},
"memberSize": {
"type": "integer",
"description": "Number of members in the group.",
"example": 1
},
"members": {
"type": "array",
"description": "A list of members of the Group.",
"items": {
"$ref": "#/components/schemas/MemberResponse"
}
},
"managedBy": {
"type": "array",
"description": "Administrators of customer groups (email is not returned).",
"items": {
"$ref": "#/components/schemas/ManagedByResponse"
}
}
}
},
"CustomerGroupsQueryResponse": {
"type": "object",
"properties": {
"totalResults": {
"type": "integer",
"description": "Total number of Customer Groups that match the query.",
"example": 9
},
"itemsPerPage": {
"type": "integer",
"description": "Number of Customer Groups returned in the current response.",
"example": 2
},
"startIndex": {
"type": "integer",
"description": "1-based index of the first result returned.",
"example": 2
},
"schemas": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of schema URNs.",
"example": [
"urn:scim:schemas:core:1.0",
"urn:scim:schemas:extension:cisco:commonidentity:1.0"
]
},
"Resources": {
"type": "array",
"description": "List of Customer Groups.",
"items": {
"$ref": "#/components/schemas/CustomerQueryGroupResponse"
}
}
}
},
"CustomerQueryGroupResponse": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Human-readable name of the Customer Group."
},
"members": {
"type": "array",
"description": "Returned only when includeMembers=true.",
"items": {
"$ref": "#/components/schemas/MemberResponse"
}
},
"memberSize": {
"type": "integer",
"description": "Number of members in the group."
},
"meta": {
"$ref": "#/components/schemas/GroupMeta"
},
"id": {
"type": "string",
"description": "Unique Customer Group identifier."
},
"description": {
"type": "string",
"description": "Description of the group.",
"example": "Customer Group For PA63"
},
"cisSyncSource": {
"type": "string",
"enum": [
"SCIM",
"DIRSYNC"
]
},
"usage": {
"type": "string",
"example": "customer_group"
}
}
},
"Member": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xOTUzOTdhMi03MTU5LTRjNTgtYTBiOC00NmQ2ZWZlZTdkMTM",
"description": "Person ID of the group member."
},
"type": {
"type": "string",
"example": "user",
"description": "Member type."
},
"displayName": {
"type": "string",
"example": "Jane Smith"
}
}
},
"PatchMember": {
"description": "Select schema for adding or removing members.",
"oneOf": [
{
"$ref": "#/components/schemas/AddMember"
},
{
"$ref": "#/components/schemas/DeleteMember"
}
]
},
"AddMember": {
"type": "object",
"description": "Schema for adding members.",
"properties": {
"value": {
"type": "string",
"description": "The entryuuid of customer org.",
"example": "cdb658ca-7aab-4336-a00b-51479273326d"
}
}
},
"DeleteMember": {
"type": "object",
"description": "Schema for removing members.",
"properties": {
"value": {
"type": "string",
"description": "The entryuuid of customer org.",
"example": "cdb658ca-7aab-4336-a00b-51479273326d"
},
"operation": {
"type": "string",
"enum": [
"delete"
],
"default": "delete",
"description": "Operation \"delete\" is supported for removing members.\n"
}
}
},
"MemberResponse": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The entryuuid of customer org.",
"example": "cdb658ca-7aab-4336-a00b-51479273326d"
}
}
},
"PatchManagedBy": {
"description": "Select schema for adding or deleting an admin.",
"oneOf": [
{
"$ref": "#/components/schemas/AddManagedBy"
},
{
"$ref": "#/components/schemas/DeleteManagedBy"
}
]
},
"AddManagedBy": {
"type": "object",
"additionalProperties": false,
"description": "Schema for adding an admin. Either 'id' or 'email' must be provided.",
"properties": {
"orgId": {
"type": "string",
"description": "The admin's organization ID."
},
"type": {
"type": "string",
"description": "Type of administrator.",
"enum": [
"user"
]
},
"id": {
"type": "string",
"description": "Entryuuid of the user."
},
"email": {
"type": "string",
"description": "Email of the user."
},
"roles": {
"type": "array",
"description": "The roles assigned to the admin.",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"orgId",
"type",
"roles"
]
},
"DeleteManagedBy": {
"type": "object",
"additionalProperties": false,
"description": "Schema for deleting an admin. Either 'id' or 'email' must be provided.",
"properties": {
"orgId": {
"type": "string",
"description": "The admin's organization ID."
},
"type": {
"type": "string",
"description": "Type of administrator.",
"enum": [
"user"
]
},
"id": {
"type": "string",
"description": "Entryuuid of the user."
},
"email": {
"type": "string",
"description": "Email of the user."
},
"roles": {
"type": "array",
"description": "The roles assigned to the admin.",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
},
"operation": {
"type": "string",
"description": "Operation to perform on the admin.",
"enum": [
"delete"
],
"default": "delete"
}
},
"required": [
"orgId",
"type",
"roles",
"operation"
]
},
"GroupMeta": {
"type": "object",
"description": "Meta data information of group.",
"required": [
"location",
"organizationID"
],
"properties": {
"created": {
"type": "string",
"format": "date-time",
"description": "The create time of group entry. ISO-8601 format.",
"example": "2025-06-20T19:53:51.207Z"
},
"lastModified": {
"type": "string",
"format": "date-time",
"description": "The last modify time of group entry. ISO-8601 format.",
"example": "2025-06-20T19:53:51.207Z"
},
"version": {
"type": "string",
"description": "The version information of group entry.",
"example": "W/\"99393996252\""
},
"location": {
"type": "string",
"format": "uri",
"description": "The request URI.",
"example": "https://webexapis.com/identity/scim/09ebb769-3098-4446-9093-4b39b296602b/v1/CustomerGroups/230898d8-f528-432f-93db-d138fa7fb20c"
},
"organizationID": {
"type": "string",
"description": "Org ID.",
"example": "09ebb769-3098-4446-9093-4b39b296602b"
}
}
},
"ArchiveUser": {
"type": "object",
"required": [
"schemas",
"id",
"userName",
"emails",
"meta"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:scim:schemas:core:1.0,urn:scim:schemas:extension:cisco:commonidentity:1.0"
},
"description": "An array of schema URNs that define the structure of the SCIM resource."
},
"userName": {
"type": "string",
"example": "test_user2@example.com",
"description": "The unique identifier for the user. This must be set to the user's primary email address. The `userName` value must be unique across Webex and is used for authentication."
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailObject"
},
"description": "A list of the user's email addresses."
},
"name": {
"$ref": "#/components/schemas/NameObject"
},
"organization": {
"type": "string",
"example": "410139c6-3bff-4404-9782-09a456ba2cae",
"description": "The unique identifier for the organization."
},
"id": {
"type": "string",
"example": "b96936c9-5b86-4a01-8969-e945c91b62f6",
"description": "The unique identifier for the user."
},
"displayName": {
"type": "string",
"example": "Mike Tang",
"description": "The display name of the user in Webex."
},
"meta": {
"$ref": "#/components/schemas/MetaObject"
}
}
},
"NameObject": {
"type": "object",
"description": "The components of the user's real name.",
"properties": {
"givenName": {
"type": "string",
"example": "Sarah",
"description": "The given name of the user, or first name in most Western languages (e.g., \"Sarah\" given the full name \"Ms. Sarah J Henderson, III\")."
},
"familyName": {
"type": "string",
"example": "Henderson",
"description": "The family name of the user, or last name in most Western languages (e.g., \"Henderson\" given the full name \"Ms. Sarah J Henderson, III\")."
},
"middleName": {
"type": "string",
"example": "Jane",
"description": "The middle name(s) of the user (e.g., \"Jane\" given the full name \"Ms. Sarah J Henderson, III\")."
},
"honorificPrefix": {
"type": "string",
"example": "Mr.",
"description": "The honorific prefix(es) of the user, or title in most Western languages (e.g., \"Ms.\" given the full name \"Ms. Sarah J Henderson, III\")."
},
"honorificSuffix": {
"type": "string",
"example": "III",
"description": "The honorific suffix(es) of the user, or suffix in most Western languages (e.g., \"III\" given the full name \"Ms. Sarah J Henderson, III\")."
}
}
},
"EmailObject": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "user1@example.home.com",
"description": "The email address."
},
"type": {
"type": "string",
"enum": [
"work",
"home",
"room",
"other"
],
"description": "The type of the email."
},
"display": {
"type": "string",
"example": "home email description",
"description": "A human-readable description, primarily used for display purposes."
},
"primary": {
"type": "boolean",
"description": "Email status boolean value. If the type is work and primary is true, the value must equal `userName`."
}
}
},
"MetaObject": {
"type": "object",
"description": "Response metadata.",
"required": [
"created",
"lastModified",
"version",
"location"
],
"properties": {
"resourceType": {
"type": "string",
"example": "User"
},
"organizationID": {
"type": "string",
"example": "The organization ID of the user"
},
"created": {
"type": "string",
"example": "2023-01-11T17:38:31.605Z",
"description": "The date and time the group was created."
},
"lastModified": {
"type": "string",
"example": "2023-01-11T17:38:31.605Z",
"description": "The date and time the group was last changed."
},
"version": {
"type": "string",
"example": "\"W\\/\\\"e180ee84f0671b1\\\"\"",
"description": "The version of the user."
},
"location": {
"type": "string",
"example": "https://webexapi.com/identity/scim/0ae87ade-8c8a-4952-af08-318798958d0c/v2/Users/3426a8e3-d414-4bf0-a493-4f6787632a13",
"description": "The resource itself."
}
}
},
"PostDomainVerificationToken": {
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"example": "cisco.com",
"description": "A valid domain name."
}
}
},
"DomainVerificationToken": {
"type": "object",
"required": [
"domain",
"token",
"verificationMethod",
"url"
],
"properties": {
"domain": {
"type": "string",
"example": "cisco.com",
"description": "The domain name for which the token is generated."
},
"token": {
"type": "string",
"example": "f5014515-6559-4a30-9d68-0deb028f27b7",
"description": "A token needs to be added as a TXT record in your domain's DNS settings. You should add the following string: 'cisco-ci-domain-verification=' as a TXT record in your DNS settings."
},
"verificationMethod": {
"type": "string",
"example": "DNS_TXT",
"description": "Domain verification method: Currently, we only support the DNS_TXT method for domain verification."
},
"url": {
"type": "string",
"example": "https://identity.webex.com/organization/bf732c85-68ca-4867-94e4-937286ad2fd4/v1/actions/DomainVerification/GetToken/invoke",
"description": "Use this URL for retrieving an authentication token needed to interact with the Domain Verification API."
}
}
},
"PostDomainVerification": {
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"example": "cisco.com",
"description": "The domain name to be verified."
},
"claimDomain": {
"type": "boolean",
"description": "A boolean to specify whether the domain needs to be claimed. The default value is false. If false, the domain will be verified but not claimed."
},
"reserveDomain": {
"type": "boolean",
"description": "For FedRAMP only: If true, add the domain to the FedRAMP reserved domain list. The default value is false."
}
}
},
"DomainVerification": {
"type": "object",
"required": [
"verifiedDomains",
"claimedDomains",
"url"
],
"properties": {
"verifiedDomains": {
"type": "array",
"items": {
"type": "string",
"example": "cisco.com,webex.com"
},
"description": "A list of verified domains for a given organization."
},
"claimedDomains": {
"type": "array",
"items": {
"type": "string",
"example": "cisco.com,webex.com"
},
"description": "A list of claimed domains for a given organization."
},
"url": {
"type": "string",
"example": "https://identity.webex.com/organization/bf732c85-68ca-4867-94e4-937286ad2fd4/v1/actions/DomainVerification/Verify/invoke",
"description": "Use this URL for verifying domain ownership and managing the domain lifecycle within the organization."
}
}
},
"Domain": {
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"example": "cisco.com",
"description": "A valid domain name that is already verified by the organization."
}
}
},
"PostClaimDomain": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Domain"
},
"description": "A List of valid domain name that is already verified by the organization."
},
"forceDomainClaim": {
"type": "boolean",
"example": true,
"description": "Indicate if the domain should be claimed when there are users outside the organization using the same domain. The default is true."
},
"claimDomainOnly": {
"type": "boolean",
"description": "Indicate to just claim the domain only without searching/marking external users as transient. The default is false."
}
}
},
"ClaimDomain": {
"type": "object",
"required": [
"domain",
"url"
],
"properties": {
"domain": {
"type": "string",
"example": "cisco.com",
"description": "A list of verified domains for a given organizations."
},
"url": {
"type": "string",
"example": "https://identity.webex.com/organizations/bf732c85-68ca-4867-94e4-937286ad2fd4/v1/domains/ZXhhbXBsZTMuY29t",
"description": "Use this location URL for the domain resource. The resource component of the URL will be the base64 encoded domain name."
}
}
},
"PostDomainUnverification": {
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"example": "abc.com",
"description": "Domain name to be verified."
},
"removePending": {
"type": "boolean",
"description": "Specify whether to remove pending domain. Default is false (backward compatibility). If true, domains will be deleted from pending domain list."
}
}
},
"DomainUnverification": {
"type": "object",
"required": [
"verifiedDomains",
"claimedDomains",
"url"
],
"properties": {
"verifiedDomains": {
"type": "array",
"items": {
"type": "string",
"example": "cisco.com,webex.com"
},
"description": "A list of verified domains for a given organization."
},
"claimedDomains": {
"type": "array",
"items": {
"type": "string",
"example": "cisco.com,webex.com"
},
"description": "A list of claimed domains for a given organization."
},
"url": {
"type": "string",
"example": "https://identity.webex.com/organization/bf732c85-68ca-4867-94e4-937286ad2fd4/v1/actions/DomainVerification/Unverify/invoke",
"description": "Use this URL for unverifying domain ownership and managing the domain lifecycle within the organization."
}
}
},
"UnclaimDomain": {
"type": "object",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"example": "test.dc-01.com",
"description": "A claimed domain."
}
}
},
"GetOrgResponse": {
"type": "object",
"required": [
"schemas",
"id",
"displayName"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:cisco:codev:identity:organization:core:1.0"
},
"description": "Output JSON schemas."
},
"id": {
"type": "string",
"example": "82adacf4-453f-4e2b-a406-2939fddcaad2",
"description": "Webex Identity assigned organization identifier."
},
"displayName": {
"type": "string",
"example": "Acme, Inc.",
"description": "Full name of the organization."
},
"preferredLanguage": {
"type": "string",
"example": "en_US",
"description": "It is the default preferredLanguage for user creation in this org. It is set in ISO639 format."
},
"meta": {
"$ref": "#/components/schemas/metaObject",
"description": "Meta data information of organization."
}
}
},
"metaObject": {
"type": "object",
"required": [
"created",
"lastModified",
"version"
],
"properties": {
"created": {
"type": "string",
"example": "\"2021-05-13T15:51:09.736Z\"",
"description": "The date and time the organization was created."
},
"lastModified": {
"type": "string",
"example": "2024-05-16T12:25:16.739Z",
"description": "The last modification time of the organization."
},
"version": {
"type": "string",
"example": "W/\\\"67863103533\\\"",
"description": "The version information of the organization."
}
}
},
"updateOrgObject": {
"type": "object",
"required": [
"schemas",
"displayName"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:cisco:codev:identity:organization:core:1.0"
},
"description": "Input JSON schemas."
},
"displayName": {
"type": "string",
"example": "Acme_New, Inc.",
"description": "New full name of the organization."
},
"preferredLanguage": {
"type": "string",
"example": "en_US",
"description": "It is the default preferredLanguage for user creation in this org. It is set in ISO639 format."
}
}
},
"GenerateOtp": {
"type": "object",
"required": [
"oneTimePassword",
"expiresIn"
],
"properties": {
"oneTimePassword": {
"type": "string",
"example": "283489",
"description": "The One-Time Password generated for the user."
},
"expiresIn": {
"type": "number",
"example": 604800,
"description": "The expiration time for the OTP in seconds (default: 7 days)."
}
}
},
"AuthenticationConfigPatchObject": {
"type": "object",
"required": [
"schemas"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:cisco:codev:identity:idbroker:authnconfig:schemas:1.0"
},
"description": "Input JSON schemas. It should contain the following schema: \n urn:cisco:codev:identity:idbroker:authnconfig:schemas:1.0"
},
"RememberMyLoginId": {
"type": "boolean",
"example": true,
"description": "Login Id set to true if it should be remembered."
},
"RememberMyLoginIdDuration": {
"type": "number",
"example": 30,
"description": "Specifies the number of days the user's login ID is remembered. Must be between 1 and 120 (inclusive)."
}
}
},
"AuthenticationConfigResponse": {
"type": "object",
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:cisco:codev:identity:idbroker:authnconfig:schemas:1.0"
},
"description": "Output JSON schemas."
},
"LockoutDuration": {
"type": "number",
"example": 1,
"description": "The number of minutes that an account will be locked out."
},
"LockoutDurationMultiplier": {
"type": "number",
"example": 1,
"description": "The multiplier of the LockoutDuration. Each subsequent lockout will be multiplied by this value."
},
"LockoutFailureCount": {
"type": "number",
"example": 5,
"description": "Number of failed login attempts that will trigger account lockout."
},
"LockoutFailureDuration": {
"type": "number",
"example": 5,
"description": "Number of minutes that a login failure will be recorded."
},
"RememberMyLoginId": {
"type": "boolean",
"example": true,
"description": "True to remember the user's Login Id."
},
"RememberMyLoginIdDuration": {
"type": "number",
"example": 30,
"description": "Specifies the number of days the user's login ID is remembered. Must be between 1 and 120 (inclusive)."
}
}
},
"PasswordPolicyObject": {
"type": "object",
"required": [
"schemas",
"minimumNumeric",
"minimumCapAlpha",
"minimumLowAlpha",
"minimumSpecial",
"minimumLength",
"historyCount",
"maxPasswordAge"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:cisco:codev:identity:idbroker:pwdpolicy:schemas:1.0"
},
"description": "Input JSON schemas. It should contain the following schema: \n urn:cisco:codev:identity:idbroker:pwdpolicy:schemas:1.0"
},
"minimumNumeric": {
"type": "string",
"example": "",
"description": "Minimum number of numeric characters in password"
},
"minimumCapAlpha": {
"type": "string",
"example": "",
"description": "Minimum number of uppercase alphabetic character letters in password"
},
"minimumLowAlpha": {
"type": "string",
"example": "",
"description": "Minimum number of lowercase alphabetic character letters in password"
},
"minimumSpecial": {
"type": "string",
"example": "",
"description": "Minimum number of special characters included \"~!@#$%^&*()-_=+[]{}|;:,.<>/?\" in password"
},
"minimumLength": {
"type": "string",
"example": "",
"description": "Minimum length of password. Must be between 8 and 256, inclusive."
},
"historyCount": {
"type": "string",
"example": "",
"description": "The number of former passwords in history, the new password can't be any one of them. Must be between 1 and 5, inclusive."
},
"maxPasswordAge": {
"type": "string",
"example": "",
"description": "The password expired time, unit: day, that means user need to change password every \"X\" days. Must be between 90 and 1825, inclusive."
},
"notAcceptableStrings": {
"type": "string",
"example": "",
"description": "The password can not be any one in this string list."
}
}
},
"PasswordPolicyResponse": {
"type": "object",
"properties": {
"minimumNumeric": {
"type": "string",
"example": "8",
"description": "Minimum number of numeric characters in password."
},
"minimumCapAlpha": {
"type": "string",
"example": "1",
"description": "Minimum number of uppercase alphabetic character letters in a password."
},
"minimumLowAlpha": {
"type": "string",
"example": "1",
"description": "Minimum number of lowercase alphabetic character letters in a password."
},
"minimumSpecial": {
"type": "string",
"example": "1",
"description": "Minimum number of special character included \"~!@#$%^&*()-_=+[]{}|;:,.<>/?\" in a password."
},
"minimumLength": {
"type": "string",
"example": "8",
"description": "Minimum length of password. Must be between 8 and 256, inclusive."
},
"historyCount": {
"type": "string",
"example": "3",
"description": "The number of former password in history, the new password can't be any one of them. Must be between 1 and 5, inclusive."
},
"maxPasswordAge": {
"type": "string",
"example": "90",
"description": "The password expired time, unit: day, that means user need to change password every \"X\" days. Must be between 90 and 1825, inclusive."
},
"notAcceptableStrings": {
"type": "string",
"example": "password,passwd,pass,webex,cisco,xebew,ocsic",
"description": "The password can not be any one in this string list."
}
}
},
"GetRolesResponse": {
"type": "object",
"required": [
"schema",
"totalResults",
"resources"
],
"properties": {
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "urn:ietf:params:scim:api:messages:2.0:ListResponse"
},
"description": "Input JSON schema."
},
"totalResults": {
"type": "number",
"example": 1,
"description": "Total Roles assigned to that org."
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource"
},
"description": "List of Roles assigned to Org."
}
}
},
"GetPartnerRolesResponse": {
"type": "object",
"required": [
"schema",
"totalResults",
"resources"
],
"properties": {
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "urn:ietf:params:scim:api:messages:2.0:ListResponse"
},
"description": "Input JSON schema."
},
"totalResults": {
"type": "number",
"example": 1,
"description": "Total Partner Roles assigned to that org."
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resource"
},
"description": "List of Partner Roles assigned to Org."
}
}
},
"Resource": {
"type": "object",
"required": [
"attribute",
"value",
"description",
"display"
],
"properties": {
"attribute": {
"type": "string",
"example": "\"urn:ietf:params:scim:api:messages:2.0:ListResponse\"",
"description": "Input JSON schema."
},
"value": {
"type": "string",
"example": "id_full_admin",
"description": "The value of a role."
},
"display": {
"type": "string",
"example": "id_full_admin",
"description": "A human-readable name, primarily used for display purposes."
},
"description": {
"type": "string",
"example": "Read-only administrator",
"description": "A human-readable description of a role."
}
}
},
"Groups": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupMembers"
}
}
}
},
"GroupMembers": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL45zL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xJWU1LWExNTItZmUzNDgxOWNkYsgh"
},
"displayName": {
"type": "string",
"example": "Test Group"
}
}
},
"Organization": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "A unique identifier for the organization."
},
"displayName": {
"type": "string",
"example": "Acme, Inc.",
"description": "Full name of the organization."
},
"created": {
"type": "string",
"example": "2015-10-18T14:26:16+00:00",
"description": "The date and time the organization was created."
}
}
},
"OrganizationCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Organization"
}
}
}
},
"PostMember": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xOTUzOTdhMi03MTU5LTRjNTgtYTBiOC00NmQ2ZWZlZTdkMTM",
"description": "Person ID."
}
}
},
"PatchMemberWithOperation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xOTUzOTdhMi03MTU5LTRjNTgtYTBiOC00NmQ2ZWZlZTdkMTM",
"description": "Person ID."
},
"operation": {
"type": "string",
"example": "add",
"description": "Operation type. Either `add` or `delete`. The default operation is `add` if no operation is specified."
}
}
},
"PostGroup": {
"type": "object",
"required": [
"schemas",
"displayName"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:ietf:params:scim:schemas:core:2.0:Group,urn:scim:schemas:extension:cisco:webexidentity:2.0:Group"
},
"description": "Input JSON schemas."
},
"displayName": {
"type": "string",
"example": "group1@example.com",
"description": "A human-readable name for the Group."
},
"externalId": {
"type": "string",
"example": "test",
"description": "An identifier for the resource as defined by the provisioning client."
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupMemberObject"
},
"description": "A list of members of this group."
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group": {
"type": "object",
"properties": {
"usage": {
"type": "string",
"example": "policy",
"description": "The identifier of this Group."
},
"owners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
"description": "The identifier of the owner of this group."
}
}
},
"description": "The owners of this group."
},
"inheritances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupInheritancesObject"
},
"description": "An array of inheritances"
},
"managedBy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManagedByObject"
},
"description": "A list of delegates of this group."
}
},
"description": "The Cisco extension of SCIM 2."
}
}
},
"PatchGroup": {
"type": "object",
"required": [
"schemas",
"Operations"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:ietf:params:scim:api:messages:2.0:PatchOp"
},
"description": "Input JSON schemas."
},
"Operations": {
"type": "array",
"items": {
"type": "object",
"required": [
"op"
],
"properties": {
"op": {
"type": "string",
"enum": [
"add",
"replace",
"remove"
],
"description": "The operation to perform."
},
"path": {
"type": "string",
"example": "displayName",
"description": "A string containing an attribute path describing the target of the operation."
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupInheritancesObject"
},
"description": "New value."
}
}
},
"description": "A list of patch operations."
}
}
},
"GroupResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvMjUxMDRiZTAtZjg3NC00MzQzLTk2MDctZGYwMmRmMzdiNWMxOjM0OGFkYjgxLTI4ZjktNGFiNS1iMmQ2LWU5YjQ5NGU3MmEwNg",
"description": "A unique identifier for the group."
},
"displayName": {
"type": "string",
"example": "Sales Group",
"description": "The name of the group."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNDhhZGI4MS0yOGY5LTRhYjUtYjJkNi1lOWI0OTRlNzJhMDY",
"description": "The ID of the organization to which this group belongs."
},
"created": {
"type": "string",
"example": "2022-02-17T02:13:29.706Z",
"description": "The timestamp indicating creation date/time of group"
},
"lastModified": {
"type": "string",
"example": "2022-02-17T02:13:29.706Z",
"description": "The timestamp indicating lastModification time of group"
},
"memberSize": {
"type": "number",
"example": 1
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Member"
},
"description": "An array of members"
}
}
},
"GroupsCollectionResponse": {
"type": "object",
"properties": {
"totalResults": {
"type": "number",
"example": 3,
"description": "Total number of groups returned in the response."
},
"startIndex": {
"type": "number",
"example": 1
},
"itemsPerPage": {
"type": "number",
"example": 10
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupResponse"
},
"description": "An array of group objects."
}
}
},
"Guest": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zNzlhNWQ4ZC1hNTE4LTQ3NmQtYmY1NC1mZmE5MWQ3OWM4MTI",
"description": "The unique id of the guest. This is a `personId`"
},
"subject": {
"type": "string",
"example": "PersonNo#1",
"description": "The external unique identifier of the guest."
},
"displayName": {
"type": "string",
"example": "Person of Interest",
"description": "The guest’s display name shown in Webex applications"
},
"email": {
"type": "string",
"example": "1ad14c30-59a6-31a7-b345-963e3d167e10@appid.ciscospark.com",
"description": "The person’s synthetic email in Webex."
},
"accessToken": {
"type": "string",
"example": "eyJhbGciOiJSUzI1NiJ9.eyJkw1zx5iIDv7FL3cWQ_JEjehqtPVRmFf572q7RZwSIZgQRziAw",
"description": "The guests access token. Guest tokens usually are over 2000 characters in length."
},
"expiresIn": {
"type": "number",
"example": 64799,
"description": "The token expiration in seconds from the time of issuance."
}
}
},
"ClusterCollection": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Cluster"
},
"description": "An array of hybrid cluster objects."
}
}
},
"Cluster": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lZY76123abbb",
"description": "A unique identifier for the cluster."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3",
"description": "The ID of the organization to which this hybrid cluster belongs."
},
"name": {
"type": "string",
"example": "EMEA Oslo 1",
"description": "The name of the cluster."
},
"resourceGroupId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3",
"description": "The ID of the resource group this cluster belongs to."
}
}
},
"ConnectorCollection": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Connector"
},
"description": "An array of hybrid connector objects."
}
}
},
"Connector": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lZY76123",
"description": "A unique identifier for the connector."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3",
"description": "The ID of the organization to which this hybrid connector belongs."
},
"hybridClusterId": {
"type": "string",
"example": "Y2lZY76123abbb",
"description": "The ID of the cluster this connector belongs to."
},
"hostname": {
"type": "string",
"example": "foo.example.org",
"description": "The hostname of the system the connector is running on."
},
"status": {
"$ref": "#/components/schemas/ConnectorStatus",
"description": "The status of the connector:\n\n- `operational` indicates that the connector is working as it should.\n\n- `impaired` indicates that the connector has problems with one or more dependent components.\n\n- `outage` indicates that the connector is completely non-functional.\n\n- `maintenanceMode` reports the current maintenance mode state of the connector."
},
"created": {
"type": "string",
"example": "2017-09-15T15:53:00Z",
"description": "The date and time the connector was created."
},
"type": {
"$ref": "#/components/schemas/ConnectorType",
"description": "The type of connector."
},
"version": {
"type": "string",
"example": "1.9_foo_zz",
"description": "The version of the software installed."
},
"alarms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Alarm"
},
"description": "A list of alarms raised on the connector."
}
}
},
"ConnectorStatus": {
"type": "string",
"enum": [
"operational",
"impaired",
"outage",
"maintenanceMode"
]
},
"ConnectorType": {
"type": "string",
"enum": [
"expresswayManagement",
"calendar",
"call",
"message",
"expresswayServiceability",
"ecpServiceability",
"videoMesh",
"dataSecurity",
"care",
"careManagement"
]
},
"AlarmCollection": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Alarm"
}
}
}
},
"Alarm": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lZY76123af234bbYY",
"description": "A unique identifier for the alarm."
},
"created": {
"type": "string",
"example": "2017-09-15T15:53:00Z",
"description": "The date and time the alarm was raised."
},
"severity": {
"$ref": "#/components/schemas/AlarmSeverity",
"description": "The severity level of the alarm:\n\n- `critical`\n\n- `error`\n\n- `warning`\n\n- `alert`"
},
"title": {
"type": "string",
"example": "Something is wrong",
"description": "The title of the alarm."
},
"description": {
"type": "string",
"example": "More detail about something being wrong",
"description": "A description of the alarm."
},
"hybridConnectorId": {
"type": "string",
"example": "Y2lZY76123af234bb",
"description": "The ID of the connector the alarm is raised on."
}
}
},
"AlarmSeverity": {
"type": "string",
"enum": [
"critical",
"warning",
"alert",
"error"
]
},
"License": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"description": "A unique identifier for the license."
},
"name": {
"type": "string",
"example": "Meeting - Webex Meeting Center",
"description": "Name of the licensed feature."
},
"totalUnits": {
"type": "number",
"example": 50,
"description": "Total number of license units allocated."
},
"consumedUnits": {
"type": "number",
"example": 5,
"description": "Total number of license units consumed."
},
"consumedByUsers": {
"type": "number",
"example": 5,
"description": "Total number of license units consumed by users."
},
"consumedByWorkspaces": {
"type": "number",
"description": "Total number of license units consumed by workspaces."
},
"subscriptionId": {
"type": "string",
"example": "Sub-hydraOct26a",
"description": "The subscription ID associated with this license. This ID is used in other systems, such as Webex Control Hub."
},
"siteUrl": {
"type": "string",
"example": "site1-example.webex.com",
"description": "The Webex Meetings site associated with this license."
},
"siteType": {
"type": "string",
"enum": [
"Control Hub managed site",
"Linked site",
"Site Admin managed site"
],
"description": "The type of site associated with this license.\n * `Control Hub managed site` - The site is managed by Webex Control Hub.\n * `Linked site` - The site is a linked site.\n * `Site Admin managed site` - The site is managed by Site Administration.\n"
}
}
},
"LicenseCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/License"
}
}
}
},
"Users": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"description": "A unique identifier for the user."
},
"type": {
"type": "string",
"enum": [
"INTERNAL",
"EXTERNAL"
],
"description": "Indicates if the user is internal or external to the organization.\n * `INTERNAL` - User resides in the license-owned organization.\n * `EXTERNAL` - User resides outside the license-owned organization.\n"
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "The full name of the user."
},
"email": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address of the user."
}
}
},
"LicensewithUsers": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"description": "A unique identifier for the license."
},
"name": {
"type": "string",
"example": "Meeting - Webex Meeting Center",
"description": "Name of the licensed feature."
},
"totalUnits": {
"type": "number",
"example": 50,
"description": "Total number of license units allocated."
},
"consumedUnits": {
"type": "number",
"example": 5,
"description": "Total number of license units consumed."
},
"consumedByUsers": {
"type": "number",
"example": 5,
"description": "Total number of license units consumed by users."
},
"consumedByWorkspaces": {
"type": "number",
"description": "Total number of license units consumed by workspaces."
},
"subscriptionId": {
"type": "string",
"example": "Sub-hydraOct26a",
"description": "The subscription ID associated with this license. This ID is used in other systems, such as Webex Control Hub."
},
"siteUrl": {
"type": "string",
"example": "site1-example.webex.com",
"description": "The Webex Meetings site associated with this license."
},
"siteType": {
"type": "string",
"enum": [
"Control Hub managed site",
"Linked site",
"Site Admin managed site"
],
"description": "The type of site associated with this license.\n * `Control Hub managed site` - The site is managed by Webex Control Hub.\n * `Linked site` - The site is a linked site.\n * `Site Admin managed site` - The site is managed by Site Administration.\n"
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Users"
},
"description": "A list of users to whom the license is assigned to."
}
}
},
"PatchUserLicenses": {
"type": "object",
"properties": {
"email": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address of the user."
},
"personId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"description": "A unique identifier for the user."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The ID of the organization to which the licenses and siteUrls belong. If not specified, the organization ID from the OAuth token is used."
},
"licenses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LicenseRequest"
},
"description": "An array of licenses to be assigned to the user."
},
"siteUrls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteUrlsRequest"
},
"description": "An array of siteUrls to be assigned to the user."
}
}
},
"LicenseRequest": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"description": "A unique identifier for the license."
},
"operation": {
"type": "string",
"enum": [
"remove",
"add"
],
"description": "Operation type. The default operation is `add` if no operation is specified.\n * `remove` - Remove the license from the user\n * `add` - Assign the license to the user\n"
},
"properties": {
"$ref": "#/components/schemas/LicenseProperties"
}
}
},
"SiteUrlsRequest": {
"type": "object",
"required": [
"siteUrl",
"accountType"
],
"properties": {
"siteUrl": {
"type": "string",
"example": "mysite.webex.com",
"description": "Attendee access on the site."
},
"accountType": {
"type": "string",
"enum": [
"attendee"
],
"description": "Account type. Only `attendee` type is supported. For host account, remove attendee and assign the license on that site.\n * `attendee` - Attendee role on the siteUrl\n"
},
"operation": {
"type": "string",
"enum": [
"remove",
"add"
],
"description": "Operation type. The default operation is `add` if no operation is specified.\n * `remove` - Remove the attendee role from the user.\n * `add` - Add the attendee role to the user.\n"
}
}
},
"UserLicensesResponse": {
"type": "object",
"properties": {
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The ID of the organization to which this user belongs."
},
"personId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"description": "A unique identifier for the user."
},
"email": {
"type": "string",
"example": "john.andersen@example.com",
"description": "The email address of this user."
},
"licenses": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LTIzNDItMGY0NTU2YWRlZXJm"
},
"description": "An array of license strings that are assigned to this user."
},
"siteUrls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteResponse"
},
"description": "An array of `siteUrls` and their `accountType` that are assigned to this user."
},
"pendingLicenses": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYWJj,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWFiY2Rl"
},
"description": "An array of license strings that are in pending state. This is only applicable to users outside the organization."
},
"pendingSiteUrls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteResponse"
},
"description": "An array of `siteUrls` and their `accountType` that are in pending state. This is only applicable to users outside the organization."
}
}
},
"SiteResponse": {
"type": "object",
"properties": {
"siteUrl": {
"type": "string",
"example": "mysite.webex.com",
"description": "`siteUrl` assigned to the user."
},
"accountType": {
"type": "string",
"enum": [
"attendee",
"host"
],
"description": "Account Type of the site.\n * `attendee` - Attendee account on the site.\n * `host` - Host account on the site.\n"
}
}
},
"LicenseProperties": {
"type": "object",
"properties": {
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"description": "The ID of the location for this user. Applicable to Webex Calling license."
},
"phoneNumber": {
"type": "string",
"example": "14085267209",
"description": "Work phone number for the user. Applicable to Webex Calling license."
},
"extension": {
"type": "string",
"example": "133",
"description": "Webex Calling extension of the user. Applicable to Webex Calling license."
}
}
},
"ErrorResponse": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A human readable description of the error."
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"description": "An array of error details."
},
"trackingId": {
"type": "string",
"description": "A unique identifier to help with debugging."
}
}
},
"ErrorDetail": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"description": "A specific error code identifying the type of error.",
"enum": [
400,
400000,
400112,
400118,
400216,
400404,
400406,
400407,
400408,
400410,
400411,
400413,
700003,
700004,
700005,
700006
]
},
"description": {
"type": "string",
"description": "A detailed description of the specific error. Error descriptions by code:\n* 400: Unable to find location.\n* 400000: License not recognized {licenses}\n* 400112: Changing a user's Webex Calling license from Professional to Standard is not allowed. The following license(s) could not be applied as requested: {licenses}\n* 400118: User management of Messenger license {licenses} is not supported\n* 400216: Request contains invalid attendee siteUrls: {siteUrl}\n* 400404: User cannot have both Webex Calling Professional and Standard License together. The following license(s) could not be applied as requested: {licenses}\n* 400406: User cannot have both Webex Calling Standard and Webex Attendant Console licenses together. The following license(s) could not be applied as requested: {licenses}\n* 400407: User cannot have both Webex Calling Standard and CX Essential licenses together. The following license(s) could not be applied as requested: {licenses}\n* 400408: User needs Webex Calling Professional license to be assigned before assigning Webex Attendant Console: {licenses}\n* 400410: Changing a user's license from CX Essential to Webex Calling Standard is not allowed. The following license(s) could not be applied as requested: {licenses}\n* 400411: Each Webex Calling license should contain its own calling properties. The following license(s) do not have properties: {licenses}\n* 400413: Could not apply the following license(s): {licenses} as the user can be assigned only one of licenses with the offer code from the list:\n* 700003: Free teams messaging mandatory for paid teams messaging license. The following license could not be applied as requested: {licenses}\n* 700004: Free teams meeting mandatory for paid teams meeting license. The following license could not be applied as requested: {licenses}\n* 700005: Free teams messaging mandatory for teams meeting license. The following license(s) could not be applied as requested: {licenses}\n* 700006: Screen Share {licenses} is implicitly assigned and cannot be removed"
}
}
},
"LicenseError": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorResponse"
}
],
"example": {
"message": "License assignment failed",
"errors": [
{
"errorCode": 400112,
"description": "Changing a user's Webex Calling license from Professional to Standard is not allowed. The following license(s) could not be applied as requested: {licenses}"
}
],
"trackingId": "NA_88b8b4ce-6338-4d3a-8d6c-22b37e62354f"
}
},
"LivemeetingByCountryRequestBody": {
"type": "object",
"description": "If neither siteIds nor siteUrl is provided, all customer meeting sites will be included.",
"properties": {
"siteIds": {
"type": "array",
"items": {
"type": "integer"
},
"description": "A list of meeting site Ids.",
"example": [
1234567,
2345678,
3456789
]
},
"siteUrl": {
"type": "string",
"description": "A site URL.",
"example": "cisco.webex.com"
}
}
},
"LivemeetingByCountryResponse": {
"type": "object",
"properties": {
"siteUrls": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of site URLs."
},
"totalLiveMeetingCount": {
"type": "integer",
"description": "Total number of live meetings."
},
"totalLiveParticipantCount": {
"type": "integer",
"description": "Total number of live participants."
},
"totalGoodQualityLiveMeetingCount": {
"type": "integer",
"description": "Total number of good quality live meetings."
},
"totalGoodQualityLiveParticipantCount": {
"type": "integer",
"description": "Total number of good quality live participants."
},
"totalBadQualityMeetingCount": {
"type": "integer",
"description": "Total number of bad quality meetings."
},
"totalBadQualityParticipantCount": {
"type": "integer",
"description": "Total number of bad quality participants."
},
"locations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"badQualityLiveMeetingCount": {
"type": "integer",
"description": "Bad quality live meeting count."
},
"badQualityLiveParticipantCount": {
"type": "integer",
"description": "Bad quality live participant count."
},
"goodQualityLiveMeetingCount": {
"type": "integer",
"description": "Good quality live meeting count."
},
"goodQualityLiveParticipantCount": {
"type": "integer",
"description": "Good quality live participant count."
},
"country": {
"type": "string",
"description": "Country name."
},
"countryLatitude": {
"type": "number",
"description": "Country latitude."
},
"countryLongitude": {
"type": "number",
"description": "Country longitude."
},
"liveMeetingCount": {
"type": "integer",
"description": "Live meeting count."
},
"liveParticipantCount": {
"type": "integer",
"description": "Live participant count."
}
},
"required": [
"country",
"countryLatitude",
"countryLongitude",
"liveMeetingCount",
"liveParticipantCount",
"badQualityLiveMeetingCount",
"badQualityLiveParticipantCount",
"goodQualityLiveMeetingCount",
"goodQualityLiveParticipantCount"
]
},
"description": "Location breakdown of live meetings."
}
}
},
"UpdateContact": {
"type": "object",
"required": [
"schemas",
"source"
],
"properties": {
"schemas": {
"type": "string",
"example": "urn:cisco:codev:identity:contact:core:1.0",
"description": "\"urn:cisco:codev:identity:contact:core:1.0\"."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "The full name of the contact."
},
"firstName": {
"type": "string",
"example": "John",
"description": "The first name of the contact."
},
"lastName": {
"type": "string",
"example": "Andersen",
"description": "The last name of the contact."
},
"companyName": {
"type": "string",
"example": "Cisco Systems",
"description": "The company the contact is working for."
},
"title": {
"type": "string",
"example": "GM",
"description": "The contact's title."
},
"address": {
"type": "string",
"example": "{\\\"city\\\" : \\\"Milpitas\\\", \\\"country\\\" : \\\"US\\\", \\\"street\\\" : \\\"1099 Bird Ave.\\\", \\\"zipCode\\\" : \\\"99212\\\"}",
"description": "Contact's address."
},
"avatarURL": {
"type": "string",
"example": "https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600",
"description": "The URL to the person's avatar in PNG format."
},
"primaryContactMethod": {
"type": "string",
"enum": [
"SIPADDRESS",
"EMAIL",
"PHONE",
"IMS"
],
"description": "The contact's primary contact method."
},
"source": {
"type": "string",
"enum": [
"CH",
"Webex4Broadworks"
],
"description": "Where the data come from."
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "user1@example.home.com",
"description": "The email address."
},
"type": {
"type": "string",
"enum": [
"work",
"home",
"room",
"other"
],
"description": "The type of the email."
},
"primary": {
"type": "boolean",
"description": "A Boolean value indicating the email status."
}
}
},
"description": "A list of the user's email addresses with an indicator of the user's primary email address."
},
"phoneNumbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "400 123 1234",
"description": "The phone number."
},
"type": {
"type": "string",
"enum": [
"work",
"home",
"mobile",
"work_extension",
"fax",
"pager",
"other"
],
"description": "The types of the phone numbers."
},
"primary": {
"type": "boolean",
"example": true,
"description": "A Boolean value indicating the phone number's primary status."
},
"operation": {
"type": "string",
"example": "delete",
"description": "- A String value on the operation, only `delete` is supported now."
}
}
},
"description": "A list of user's phone numbers with an indicator of primary to specify the user's main number."
},
"sipAddresses": {
"type": "array",
"items": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "sipAddress value1",
"description": "The sipAddress value."
},
"type": {
"type": "string",
"enum": [
"enterprise",
"cloud-calling",
"personal-room"
],
"description": "The type of the sipAddress."
},
"primary": {
"type": "boolean",
"example": true,
"description": "Designate the primary sipAddress."
}
}
},
"description": "The sipAddress values for the user."
},
"ims": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "aim_account_ID",
"description": "The IMS account value."
},
"type": {
"type": "string",
"enum": [
"aim",
"cucm-jid",
"gtalk",
"icq",
"msn",
"qq",
"skype",
"webex-messenger-jid",
"webex-squared-jid",
"xmpp",
"yahoo",
"microsoft-sip-uri",
"xmpp-fed-jid"
],
"description": "The type of the IMS."
},
"primary": {
"type": "boolean",
"example": true,
"description": "A Boolean value indicating the IMS account status."
}
}
},
"description": "Instant messaging addresses for the user."
},
"groupIds": {
"type": "array",
"items": {
"type": "string",
"example": "9ac175bf-0249-4287-8fb3-e320e525fcf6"
},
"description": "Groups associated with the contact."
}
}
},
"Contact": {
"type": "object",
"required": [
"schemas",
"source"
],
"properties": {
"schemas": {
"type": "string",
"example": "urn:cisco:codev:identity:contact:core:1.0",
"description": "\"urn:cisco:codev:identity:contact:core:1.0\"."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "The full name of the contact."
},
"firstName": {
"type": "string",
"example": "John",
"description": "The first name of the contact."
},
"lastName": {
"type": "string",
"example": "Andersen",
"description": "The last name of the contact."
},
"companyName": {
"type": "string",
"example": "Cisco Systems",
"description": "The company the contact is working for."
},
"title": {
"type": "string",
"example": "GM",
"description": "The contact's title."
},
"address": {
"type": "string",
"example": "{\\\"city\\\" : \\\"Milpitas\\\", \\\"country\\\" : \\\"US\\\", \\\"street\\\" : \\\"1099 Bird Ave.\\\", \\\"zipCode\\\" : \\\"99212\\\"}",
"description": "Contact's address."
},
"avatarURL": {
"type": "string",
"example": "https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600",
"description": "The URL to the person's avatar in PNG format."
},
"primaryContactMethod": {
"type": "string",
"enum": [
"SIPADDRESS",
"EMAIL",
"PHONE",
"IMS"
],
"description": "The contact's primary contact method."
},
"source": {
"type": "string",
"enum": [
"CH",
"Webex4Broadworks"
],
"description": "Data source."
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "user1@example.home.com",
"description": "The email address."
},
"type": {
"type": "string",
"enum": [
"work",
"home",
"room",
"other"
],
"description": "The type of the email."
},
"primary": {
"type": "boolean",
"description": "A Boolean value indicating the email status."
}
}
},
"description": "A list of the user's email addresses with an indicator of the user's primary email address."
},
"phoneNumbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "400 123 1234",
"description": "The phone number."
},
"type": {
"type": "string",
"enum": [
"work",
"home",
"mobile",
"work_extension",
"fax",
"pager",
"other"
],
"description": "The types of the phone numbers."
},
"primary": {
"type": "boolean",
"example": true,
"description": "A Boolean value indicating the phone number's primary status."
}
}
},
"description": "A list of user's phone numbers with an indicator of primary to specify the user's main number."
},
"sipAddresses": {
"type": "array",
"items": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "sipAddress value1",
"description": "The SIP address."
},
"type": {
"type": "string",
"enum": [
"enterprise",
"cloud-calling",
"personal-room"
],
"description": "SIP address type."
},
"primary": {
"type": "boolean",
"example": true,
"description": "Designate the primary sipAddress."
}
}
},
"description": "The SIP addresses for the user."
},
"ims": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "aim_account_ID",
"description": "The IMS account value."
},
"type": {
"type": "string",
"enum": [
"aim",
"cucm-jid",
"gtalk",
"icq",
"msn",
"qq",
"skype",
"webex-messenger-jid",
"webex-squared-jid",
"xmpp",
"yahoo",
"microsoft-sip-uri",
"xmpp-fed-jid"
],
"description": "The type of the IMS."
},
"primary": {
"type": "boolean",
"example": true,
"description": "A Boolean value indicating the IMS account status."
}
}
},
"description": "Instant messaging addresses for the user."
},
"groupIds": {
"type": "array",
"items": {
"type": "string",
"example": "9ac175bf-0249-4287-8fb3-e320e525fcf6"
},
"description": "Groups associated with the contact."
}
}
},
"BulkCreate": {
"type": "object",
"required": [
"schemas",
"contacts"
],
"properties": {
"schemas": {
"type": "string",
"example": "urn:cisco:codev:identity:contact:core:1.0",
"description": "\"urn:cisco:codev:identity:contact:core:1.0\"."
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"required": [
"source"
],
"properties": {
"contactId": {
"type": "string",
"example": "6847ee0f-5e9c-4403-9f0e-0aa8552f7828",
"description": "Use this to update an existing contact."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "The full name of the contact."
},
"firstName": {
"type": "string",
"example": "John",
"description": "The first name of the contact."
},
"lastName": {
"type": "string",
"example": "Andersen",
"description": "The last name of the contact."
},
"companyName": {
"type": "string",
"example": "Cisco Systems",
"description": "The company the contact is working for."
},
"title": {
"type": "string",
"example": "GM",
"description": "The contact's title."
},
"address": {
"type": "string",
"example": "{\\\"city\\\" : \\\"Milpitas\\\", \\\"country\\\" : \\\"US\\\", \\\"street\\\" : \\\"1099 Bird Ave.\\\", \\\"zipCode\\\" : \\\"99212\\\"}",
"description": "Contact's address."
},
"avatarURL": {
"type": "string",
"example": "https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600",
"description": "The URL to the person's avatar in PNG format."
},
"primaryContactMethod": {
"type": "string",
"enum": [
"SIPADDRESS",
"EMAIL",
"PHONE",
"IMS"
],
"description": "The contact's primary contact method."
},
"source": {
"type": "string",
"enum": [
"CH",
"Webex4Broadworks"
],
"description": "Where the data come from."
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "user1@example.home.com",
"description": "The email address."
},
"type": {
"type": "string",
"enum": [
"work",
"home",
"room",
"other"
],
"description": "The type of the email."
},
"primary": {
"type": "boolean",
"description": "A Boolean value indicating the email status."
}
}
},
"description": "A list of the user's email addresses with an indicator of the user's primary email address."
},
"phoneNumbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "400 123 1234",
"description": "The phone number."
},
"type": {
"type": "string",
"enum": [
"work",
"home",
"mobile",
"work_extension",
"fax",
"pager",
"other"
],
"description": "The types of phone numbers."
},
"primary": {
"type": "boolean",
"example": true,
"description": "A Boolean value indicating the phone number's primary status."
}
}
},
"description": "A list of user's phone numbers with an indicator of primary to specify the user's main number."
},
"sipAddresses": {
"type": "array",
"items": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "sipAddress value1",
"description": "The sipAddress value."
},
"type": {
"type": "string",
"enum": [
"enterprise",
"cloud-calling",
"personal-room"
],
"description": "The type of the sipAddress."
},
"primary": {
"type": "boolean",
"example": true,
"description": "Designate the primary sipAddress."
}
}
},
"description": "The sipAddress values for the user."
},
"ims": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "aim_account_ID",
"description": "The IMS account value."
},
"type": {
"type": "string",
"enum": [
"aim",
"cucm-jid",
"gtalk",
"icq",
"msn",
"qq",
"skype",
"webex-messenger-jid",
"webex-squared-jid",
"xmpp",
"yahoo",
"microsoft-sip-uri",
"xmpp-fed-jid"
],
"description": "The type of the IMS."
},
"primary": {
"type": "boolean",
"example": true,
"description": "A Boolean value indicating the IMS account status."
}
}
},
"description": "Instant messaging addresses for the user."
}
}
},
"description": "Contains a list of contacts to be created/updated."
}
}
},
"BulkDelete": {
"type": "object",
"required": [
"schemas",
"objectIds"
],
"properties": {
"schemas": {
"type": "string",
"example": "urn:cisco:codev:identity:contact:core:1.0",
"description": "\"urn:cisco:codev:identity:contact:core:1.0\"."
},
"objectIds": {
"type": "array",
"items": {
"type": "string",
"example": "8a5fac49-2c5f-4773-aec7-02db0e3a9d72"
},
"description": "List of UUIDs for the contacts."
}
}
},
"ContactResponse": {
"type": "object",
"required": [
"schemas",
"meta",
"source"
],
"properties": {
"schemas": {
"type": "string",
"example": "urn:cisco:codev:identity:contact:core:1.0",
"description": "\"urn:cisco:codev:identity:contact:core:1.0\"."
},
"meta": {
"$ref": "#/components/schemas/Meta",
"description": "Response metadata."
},
"contactId": {
"type": "string",
"example": "6847ee0f-5e9c-4403-9f0e-0aa8552f7828",
"description": "The unique identifier for the contact."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "The full name of the contact."
},
"firstName": {
"type": "string",
"example": "John",
"description": "The first name of the contact."
},
"lastName": {
"type": "string",
"example": "Andersen",
"description": "The last name of the contact."
},
"companyName": {
"type": "string",
"example": "Cisco Systems",
"description": "The company the contact is working for."
},
"title": {
"type": "string",
"example": "GM",
"description": "The contact's title."
},
"address": {
"type": "string",
"example": "{\\\"city\\\" : \\\"Milpitas\\\", \\\"country\\\" : \\\"US\\\", \\\"street\\\" : \\\"1099 Bird Ave.\\\", \\\"zipCode\\\" : \\\"99212\\\"}",
"description": "Contact's address."
},
"avatarURL": {
"type": "string",
"example": "https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600",
"description": "The URL to the person's avatar in PNG format."
},
"addressInfo": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "The city."
},
"country": {
"type": "string",
"description": "The country."
},
"street": {
"type": "string",
"description": "The street address."
},
"zipCode": {
"type": "string",
"description": "The ZIP code."
}
},
"description": "Structured address information."
},
"primaryContactMethod": {
"type": "string",
"enum": [
"SIPADDRESS",
"EMAIL",
"PHONE",
"IMS"
],
"description": "The contact's primary contact method."
},
"source": {
"type": "string",
"enum": [
"CH",
"Webex4Broadworks"
],
"description": "Where the data come from."
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "user1@example.home.com",
"description": "The email address."
},
"type": {
"type": "string",
"enum": [
"work",
"home",
"room",
"other"
],
"description": "The type of the email."
},
"primary": {
"type": "boolean",
"description": "A Boolean value indicating the email status."
}
}
},
"description": "A list of the user's email addresses with an indicator of the user's primary email address."
},
"phoneNumbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "400 123 1234",
"description": "The phone number."
},
"type": {
"type": "string",
"enum": [
"work",
"home",
"mobile",
"work_extension",
"fax",
"pager",
"other"
],
"description": "The types of the phone numbers."
},
"primary": {
"type": "boolean",
"example": true,
"description": "A Boolean value indicating the phone number's primary status."
}
}
},
"description": "A list of user's phone numbers with an indicator of primary to specify the user's main number."
},
"sipAddresses": {
"type": "array",
"items": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "sipAddress value1",
"description": "The sipAddress value."
},
"type": {
"type": "string",
"enum": [
"enterprise",
"cloud-calling",
"personal-room"
],
"description": "The type of the sipAddress."
},
"primary": {
"type": "boolean",
"example": true,
"description": "Designate the primary sipAddress."
}
}
},
"description": "The sipAddress values for the user."
},
"ims": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "aim_account_ID",
"description": "The IMS account value."
},
"type": {
"type": "string",
"enum": [
"aim",
"cucm-jid",
"gtalk",
"icq",
"msn",
"qq",
"skype",
"webex-messenger-jid",
"webex-squared-jid",
"xmpp",
"yahoo",
"microsoft-sip-uri",
"xmpp-fed-jid"
],
"description": "The type of the IMS."
},
"primary": {
"type": "boolean",
"example": true,
"description": "A Boolean value indicating the IMS account status."
}
}
},
"description": "Instant messaging addresses for the user."
},
"isMigration": {
"type": "boolean",
"description": "Indicates if this contact is part of a migration."
},
"orgId": {
"type": "string",
"example": "d23736ac-8055-433e-b85a-0fc55c96ead9",
"description": "The organization ID that the contact belongs to."
},
"groupIds": {
"type": "array",
"items": {
"type": "string",
"example": "9ac175bf-0249-4287-8fb3-e320e525fcf6"
},
"description": "Groups associated with the contact."
}
}
},
"BulkCreateResponse": {
"type": "object",
"properties": {
"contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactResponse"
},
"description": "Array of contact successfully created."
},
"failedContacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "2",
"description": "Bulk ID of the contact object that failed creation."
},
"errorCode": {
"type": "number",
"example": 403,
"description": "HTTP Response code for the contact creation failure."
},
"errorMessage": {
"type": "string",
"example": "Source null is not supported by organization, only sources [CH] are allowed",
"description": "Error message for the contact creation failure."
}
}
},
"description": "Array of contacts that failed creation."
},
"orgId": {
"type": "string",
"example": "36818b6f-ef07-43d1-b76f-ced79ab2e3e7",
"description": "Organization ID in which the contacts were created."
}
}
},
"Meta": {
"type": "object",
"properties": {
"created": {
"type": "string",
"example": "2022-04-29T13:06:26.831Z",
"description": "The date and time the contact was created."
},
"lastModified": {
"type": "string",
"example": "2022-05-29T13:06:26.831Z",
"description": "The date and time the contact was last changed."
}
}
},
"SearchResponse": {
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactResponse"
},
"description": "An array of contact objects."
},
"start": {
"type": "number",
"description": "Start at the zero-based offset in the list of matching contacts."
},
"limit": {
"type": "number",
"example": 1000,
"description": "Limit the number of contacts returned to this maximum count."
},
"total": {
"type": "number",
"example": 1,
"description": "Total number of contacts returned in search results."
}
}
},
"IdentityManagedOrg": {
"type": "object",
"properties": {
"orgId": {
"type": "string",
"example": "Y2LZY29ZCGFYAZOVL3VZL1BFT1BMRS9MNWIZNJE4NY1JOGRKLTQ3MJCTOGIYZI1MOWM0NDDMMJKWNDY",
"description": "The org ID of the managed org."
},
"role": {
"type": "string",
"example": "YXRSYXMTCG9YDGFSLNBHCNRUZXIUC2FSZXNMDWXSYWRTAW4=",
"description": "role ID of the user to this org."
}
}
},
"PartnerAdminUser": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2LZY29ZCGFYAZOVL3VZL1BFT1BMRS9JOTYWOTZIYI1KYTRHLTQ3NZETYTC2ZI1KNDEZODQWZWVM1TQ",
"description": "The user ID of the partner admin."
},
"displayName": {
"type": "string",
"example": "display name",
"description": "The display name of the partner admin."
},
"firstName": {
"type": "string",
"example": "John",
"description": "The first name of the partner admin."
},
"lastName": {
"type": "string",
"example": "Doe",
"description": "The last name of the partner admin."
},
"emails": {
"type": "array",
"items": {
"type": "string",
"example": "johndoe@example.com"
},
"description": "List of emails for the partner admin."
},
"roleInCustomerOrg": {
"type": "string",
"example": "id_full_admin",
"description": "The role of this partner admin in the given customer org."
}
}
},
"ManagedOrgsResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentityManagedOrg"
},
"description": "An array of managed orgs objects."
}
}
},
"PartneradminsfororgResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartnerAdminUser"
},
"description": "An array of partner admin user details."
}
}
},
"Policy": {
"type": "object",
"required": [
"type"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
"description": "A unique identifier for the policy."
},
"appId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
"description": "The `appId` of the app to which the policy applies."
},
"name": {
"type": "string",
"example": "Allow App 123",
"description": "A user-friendly name for the policy."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
"description": "The `orgId` of the organization to which the policy applies."
},
"type": {
"type": "string",
"enum": [
"default",
"custom"
],
"description": "A policy type for the policy.\n * `default` - Default policy for the org.\n * `custom` - Customized policy for an App.\n"
},
"personIds": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0,Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0,Y2lzY29zcGFyazovL3VzL0NBTExTLzU0MUFFMzBFLUUyQzUtNERENi04NTM4LTgzOTRDODYzM0I3MQo"
},
"description": "The `personIds` for the people this policy applies to."
},
"action": {
"type": "string",
"enum": [
"allow",
"deny"
],
"description": "The policy action.\n * `allow` - Integration usage allowed.\n * `deny` - Integration usage denied.\n"
},
"created": {
"type": "string",
"example": "2017-05-10T19:39:27.970Z",
"description": "The date and time the policy was created."
}
}
},
"PolicyCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Policy"
}
}
}
},
"ValidationRules": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "templateId",
"description": "Field on which validation rule is applied"
},
"required": {
"type": "string",
"example": "yes",
"description": "Whether the above field is required"
}
}
},
"ValidationRulesCollection": {
"type": "object",
"properties": {
"validations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationRules"
},
"description": "An array of validation rules"
}
}
},
"ResourceGroupMembership": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQX01FTUJFUlNISVAvcGVyc29uSWQ6bGljZW5zZUlk",
"description": "A unique identifier for the resource group membership."
},
"resourceGroupId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQL2RlZmF1bHQ",
"description": "The resource group ID."
},
"licenseId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvMWNjYmJjMTctZDYxNi00ZDc0LTg2NGItYjFmM2IwNzAxZmJhOk1TXzAzMDRjMDkzLTFjM2MtNDRlMC1iYjBhLWU1ZDE2NDM2NmQ1OQ",
"description": "The license ID."
},
"personId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"description": "The person ID."
},
"personOrgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The organization ID of the person."
},
"status": {
"type": "string",
"enum": [
"pending",
"activated",
"error"
],
"description": "The activation status of the resource group membership.\n * `pending` - activation pending\n * `activated` - activated\n * `error` - error present\n"
}
}
},
"ResourceGroupMembershipCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceGroupMembership"
}
}
}
},
"ResourceGroup": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQL2RlZmF1bHQ",
"description": "A unique identifier for the resource group."
},
"name": {
"type": "string",
"example": "Resource Group 1",
"description": "A user-friendly name for the resource group."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The ID of the organization to which this resource group belongs."
}
}
},
"ResourceGroupCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceGroup"
}
}
}
},
"Role": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"description": "A unique identifier for the role."
},
"name": {
"type": "string",
"example": "Full Administrator",
"description": "The name of the role."
}
}
},
"RoleCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
}
}
},
"BulkUser": {
"type": "object",
"required": [
"schemas",
"failOnErrors",
"operations"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:ietf:params:scim:api:messages:2.0:BulkRequest"
},
"description": "Input JSON schemas."
},
"failOnErrors": {
"type": "number",
"example": 99,
"description": "An integer specifying the maximum number of errors that the service provider will accept before the operation is terminated and an error response is returned."
},
"operations": {
"type": "array",
"items": {
"type": "object",
"required": [
"method",
"path"
],
"properties": {
"method": {
"type": "string",
"enum": [
"POST",
"PATCH",
"DELETE"
],
"description": "The HTTP method of the current operation."
},
"path": {
"type": "string",
"example": "/Users/2819c223-7f76-453a-919d-413861904646",
"description": "The resource's relative path. If the method is POST, the value must specify a resource type endpoint, for example `/Users` or `/Groups`. All other method values must specify the path to a specific resource."
},
"data": {
"type": "string",
"example": "JSON text",
"description": "The Resource JSON data as it appears for a single POST or PATCH resource operation."
},
"bulkId": {
"type": "string",
"example": "ytrewq",
"description": "The transient identifier of a newly created resource, unique within a bulk request and created by the client."
}
}
},
"description": "Contains a list of bulk operations for POST/PATCH/DELETE operations."
}
}
},
"PutGroup": {
"type": "object",
"required": [
"schemas",
"displayName"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:ietf:params:scim:schemas:core:2.0:Group,urn:scim:schemas:extension:cisco:webexidentity:2.0:Group"
},
"description": "Input JSON schemas."
},
"displayName": {
"type": "string",
"example": "group1@example.com",
"description": "A human-readable name for the group."
},
"externalId": {
"type": "string",
"example": "test",
"description": "An identifier for the resource as defined by the provisioning client."
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupMemberObject"
},
"description": "A list of members of this group."
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group": {
"type": "object",
"properties": {
"usage": {
"type": "string",
"example": "policy",
"description": "The identifier of this Group."
},
"owners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
"description": "The identifier of the owner of this group."
}
}
},
"description": "The owners of this group."
},
"inheritances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupInheritancesObject"
},
"description": "An array of inheritances"
},
"managedBy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManagedByObject"
},
"description": "A list of delegates of this group."
}
},
"description": "The Cisco extension of SCIM 2."
}
}
},
"GetGroupResponse": {
"type": "object",
"required": [
"schemas",
"displayName",
"id",
"meta"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:ietf:params:scim:schemas:core:2.0:Group,urn:scim:schemas:extension:cisco:webexidentity:2.0:Group"
},
"description": "Input JSON schemas."
},
"displayName": {
"type": "string",
"example": "group1@example.com",
"description": "A human-readable name for the group."
},
"id": {
"type": "string",
"example": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"description": "A unique identifier for the group."
},
"externalId": {
"type": "string",
"example": "test",
"description": "An identifier for the resource as defined by the provisioning client."
},
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "user",
"description": "A label indicating the type of resource, for example user, machine, or group."
},
"value": {
"type": "string",
"example": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
"description": "The identifier of the member of this Group."
},
"display": {
"type": "string",
"example": "A user",
"description": "A human-readable name for the group member."
},
"$ref": {
"type": "string",
"example": "https://example.com/v2/Users/c5349664-9f3d-410b-8bd3-6c31f181f13d",
"description": "The URI corresponding to a SCIM resource that is a member of this Group."
}
}
},
"description": "A list of members of this group."
},
"meta": {
"$ref": "#/components/schemas/MetaObject",
"description": "Response metadata."
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group": {
"type": "object",
"required": [
"usage",
"provisionSource",
"meta"
],
"properties": {
"usage": {
"type": "string",
"example": "location",
"description": "The identifier of this group."
},
"owners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
"description": "The identifier of the owner of this Group."
}
}
},
"description": "The owners of this group."
},
"managedBy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManagedByObject"
},
"description": "A list of delegates of this group."
},
"provisionSource": {
"type": "string",
"example": "AD",
"description": "The identifier of the source."
},
"inheritances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupInheritancesObject"
},
"description": "An array of inheritances"
},
"meta": {
"type": "object",
"required": [
"organizationID"
],
"properties": {
"organizationID": {
"type": "string",
"example": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"description": "The ID of the organization to which this group belongs."
}
},
"description": "Response metadata."
}
},
"description": "The Cisco extention of SCIM 2"
}
}
},
"SearchGroupResponse": {
"type": "object",
"required": [
"schemas"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:scim:schemas:extension:cisco:webexidentity:2.0:GroupMembers"
},
"description": "Input JSON schemas."
},
"memberSize": {
"type": "number",
"example": 2,
"description": "Total number of groups in search results."
},
"itemsPerPage": {
"type": "number",
"example": 2,
"description": "The total number of items in a paged result."
},
"startIndex": {
"type": "number",
"example": 1,
"description": "Start at the one-based offset in the list of matching contacts."
},
"Resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetGroupResponse"
},
"description": "An array of group objects."
}
}
},
"GroupInheritancesObject": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"role"
],
"example": "role",
"description": "Type of inheritance. Currently, only the `role` type is supported. Only `policy` usage supports inheritance."
},
"value": {
"type": "string",
"example": "id_full_admin",
"description": "The value of the inheritance. For the role type, this can be role names such as `id_full_admin`, `id_user_admin`, etc."
},
"nested": {
"type": "boolean",
"example": false,
"description": "Indicates whether this inheritance is nested."
},
"scope": {
"type": "array",
"items": {
"type": "string",
"example": [
"user"
]
},
"description": "Indicates which types of entities can inherit this property."
}
}
},
"GroupMemberResponse": {
"type": "object",
"required": [
"schemas",
"displayName"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:ietf:params:scim:api:messages:2.0:ListResponse"
},
"description": "Input JSON schemas."
},
"displayName": {
"type": "string",
"example": "group1@example.com",
"description": "A human-readable name for the group."
},
"totalResults": {
"type": "number",
"example": 2,
"description": "Total number of groups in search results."
},
"itemsPerPage": {
"type": "number",
"example": 2,
"description": "The total number of items in a paged result."
},
"startIndex": {
"type": "number",
"example": 1,
"description": "Start at the one-based offset in the list of matching groups."
},
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "user",
"description": "A label indicating the type of resource, for example user, machine, or group."
},
"value": {
"type": "string",
"example": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
"description": "The identifier of the member of this Group."
},
"display": {
"type": "string",
"example": "A user",
"description": "A human-readable name for the group member."
}
}
},
"description": "A list of members of this group."
}
}
},
"GroupMemberObject": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
"description": "The identifier of the member of this Group."
},
"type": {
"type": "string",
"example": "user",
"description": "A label indicating the type of resource, for example user, machine, or group."
}
}
},
"GetGroupSchemaResponse": {
"type": "object",
"properties": {
"urn:ietf:params:scim:schemas:core:2.0:Group": {
"type": "object",
"required": [
"id",
"name",
"description"
],
"properties": {
"id": {
"type": "string",
"example": "urn:ietf:params:scim:schemas:core:2.0:Group",
"description": "A unique identifier for the group."
},
"name": {
"type": "string",
"example": "Group",
"description": "The name of the group."
},
"description": {
"type": "string",
"example": "Group",
"description": "Description of the group."
},
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttributesObject"
},
"description": "A list of attributes of this group."
}
},
"description": "The core extension of SCIM 2."
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:Group": {
"type": "object",
"required": [
"id",
"name",
"description"
],
"properties": {
"id": {
"type": "string",
"example": "urn:scim:schemas:extension:cisco:webexidentity:2.0:Group",
"description": "A unique identifier for the group."
},
"name": {
"type": "string",
"example": "Cisco Group",
"description": "The name of the group."
},
"description": {
"type": "string",
"example": "Cisco Group",
"description": "Description of the group."
},
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttributesObject"
},
"description": "A list of attributes of this group."
}
},
"description": "The core extension of SCIM 2."
}
}
},
"GetGroupResponseBySchemaId": {
"type": "object",
"properties": {
"urn:ietf:params:scim:schemas:core:2.0:Group": {
"type": "object",
"required": [
"id",
"name",
"description"
],
"properties": {
"id": {
"type": "string",
"example": "urn:ietf:params:scim:schemas:core:2.0:Group",
"description": "A unique identifier for the group."
},
"name": {
"type": "string",
"example": "Group",
"description": "The name of the group."
},
"description": {
"type": "string",
"example": "Group",
"description": "Description of the group."
},
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttributesObject"
},
"description": "A list of attributes of this group."
}
},
"description": "The Cisco extension of SCIM 2."
}
}
},
"GetUserSchemaResponse": {
"type": "object",
"properties": {
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User": {
"type": "object",
"required": [
"id",
"name",
"description"
],
"properties": {
"id": {
"type": "string",
"example": "urn:scim:schemas:extension:cisco:webexidentity:2.0:User",
"description": "A unique identifier for the user."
},
"name": {
"type": "string",
"example": "EnterpriseUser",
"description": "The name of the user."
},
"description": {
"type": "string",
"example": "Enterprise User",
"description": "Description of the user."
},
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserAttributesObject"
},
"description": "A list of attributes of this user."
}
},
"description": "The Cisco extension of SCIM 2."
},
"urn:ietf:params:scim:schemas:core:2.0:User": {
"type": "object",
"required": [
"id",
"name",
"description"
],
"properties": {
"id": {
"type": "string",
"example": "urn:ietf:params:scim:schemas:core:2.0:User",
"description": "A unique identifier for the user."
},
"name": {
"type": "string",
"example": "User",
"description": "The name of the user."
},
"description": {
"type": "string",
"example": "User account",
"description": "Description of the user."
},
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserAttributesObject"
},
"description": "A list of attributes of this user."
}
},
"description": "The core extension of SCIM 2."
},
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"type": "object",
"required": [
"id",
"name",
"description"
],
"properties": {
"id": {
"type": "string",
"example": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"description": "A unique identifier for the user."
},
"name": {
"type": "string",
"example": "EnterpriseUser",
"description": "The name of the user."
},
"description": {
"type": "string",
"example": "Enterprise User",
"description": "Description of the user."
},
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserAttributesObject"
},
"description": "A list of attributes of this user."
}
},
"description": "Enterprise extension of SCIM 2."
}
}
},
"AttributesObject": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "id",
"description": "The name of the group."
},
"type": {
"type": "string",
"example": "String",
"description": "The type of the group."
},
"multiValued": {
"type": "boolean",
"description": "A boolean value for the group."
},
"description": {
"type": "string",
"example": "A unique identifier of this Group resource defined by the service provider.",
"description": "Description of the group."
},
"required": {
"type": "boolean",
"description": "A boolean value for the group."
},
"caseExact": {
"type": "boolean",
"example": true,
"description": "A boolean value for the group."
},
"mutability": {
"type": "string",
"example": "ReadOnly",
"description": "Mutability of the group."
},
"returned": {
"type": "string",
"example": "Default",
"description": "Returned value of the group."
},
"uniqueness": {
"type": "string",
"example": "Global",
"description": "Uniqueness of the group."
},
"length": {
"type": "number",
"example": 512,
"description": "This describes the extent or measurement of something from end to end, quantified as 512."
},
"subAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubAttributesObject"
},
"description": "A list of sub-attributes of this group."
},
"size": {
"type": "number",
"example": 500,
"description": "This refers to the measurement or magnitude of an object, entity, or dataset, quantified as 500."
},
"canonicalValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CanonicalValuesObject"
},
"description": "A list of canonical values of this group."
}
}
},
"SubAttributesObject": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "value",
"description": "The name of the group."
},
"type": {
"type": "string",
"example": "Reference",
"description": "The type of the group."
},
"referenceTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferenceTypesObject"
},
"description": "An array of additional information about reference types of the group."
},
"multiValued": {
"type": "boolean",
"description": "A boolean value for the group."
},
"description": {
"type": "string",
"example": "The identifier of the member of this Group.",
"description": "Description of the group."
},
"required": {
"type": "boolean",
"description": "A boolean value for the group."
},
"caseExact": {
"type": "boolean",
"description": "A boolean value for the group."
},
"mutability": {
"type": "string",
"example": "Immutable",
"description": "Mutability of the group."
},
"returned": {
"type": "string",
"example": "Default",
"description": "Returned value of the group."
},
"uniqueness": {
"type": "string",
"example": "None",
"description": "Uniqueness of the group."
},
"canonicalValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CanonicalValuesObject"
},
"description": "A list of canonical values of this group."
}
}
},
"UserAttributesObject": {
"type": "object",
"required": [
"referenceTypes"
],
"properties": {
"name": {
"type": "string",
"example": "value",
"description": "The name of the user."
},
"type": {
"type": "string",
"example": "Reference",
"description": "The type of the user."
},
"referenceTypes": {
"$ref": "#/components/schemas/ReferenceTypesObject",
"description": "An array of additional information about reference types of the group."
},
"multiValued": {
"type": "boolean",
"description": "A boolean value for the user."
},
"description": {
"type": "string",
"example": "The identifier of the member of this Group.",
"description": "Description of the user."
},
"required": {
"type": "boolean",
"description": "A boolean value for the user."
},
"caseExact": {
"type": "boolean",
"description": "A boolean value for the user."
},
"mutability": {
"type": "string",
"example": "Immutable",
"description": "Mutability of the user."
},
"returned": {
"type": "string",
"example": "Default",
"description": "Returned value of the user."
},
"canonicalValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CanonicalValuesObject"
},
"description": "A list of canonical values of this user."
},
"uniqueness": {
"type": "string",
"example": "None",
"description": "Uniqueness of the user."
},
"subAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubAttributesObject"
},
"description": "A list of sub-attributes of this user."
},
"size": {
"type": "number",
"example": 50,
"description": "This refers to the measurement or magnitude of an object, entity, or dataset, quantified as 50."
},
"length": {
"type": "number",
"example": 128,
"description": "This describes the extent or measurement of something from end to end, quantified as 128."
}
}
},
"ReferenceTypesObject": {
"type": "string",
"enum": [
"external",
"Group",
"User",
"Machine"
],
"description": " * `external` - Represents a reference to entities or resources that exist outside the current system or organization.\n * `Group` - Refers to a reference type that identifies a collection of users or entities within a system.\n * `User` - Denotes a reference to an individual who interacts with the system.\n * `Machine` - Indicates a reference to a computing device or automated system.\n"
},
"CanonicalValuesObject": {
"type": "string",
"enum": [
"Group",
"User",
"Machine",
"location",
"distribution",
"policy",
"SCIM",
"AD",
"AAD",
"BROADWORKS",
"OKTA",
"role",
"id_user_admin",
"id_readonly_admin",
"id_device_admin",
"id_full_admin",
"user",
"unique_flat_static",
"dynamic",
"flat_static",
"nested_static",
"compliance",
"pending",
"marked_deleted",
"transient",
"fraud",
"active",
"disabled",
"suspended",
"facebook",
"O365",
"google",
"cco",
"enterprise",
"cloud",
"personal",
"Everyone",
"Internal",
"Hidden",
"Global",
"phone",
"partner",
"email",
"ciRole",
"serviceRole",
"globalRole",
"other",
"work",
"room",
"home",
"external_calling",
"calling_service",
"alternate1",
"mobile",
"work_extension",
"fax",
"alternate2",
"qq",
"aim",
"cucm",
"webex",
"msn",
"xmpp",
"skype",
"gtalk",
"icq",
"yahoo",
"microsoft",
"thumbnail",
"resizable",
"photo"
],
"description": " * `Group` - Represents a set of users or entities.\n * `User` - Denotes an individual with access credentials to interact with a system or application.\n * `Machine` - Refers to a computing device or automated system within a network.\n * `location` - Indicates the physical or virtual place where an entity operates.\n * `distribution` - Relates to the dissemination or allocation of resources, tasks, or information within a system.\n * `policy` - Represents rules or guidelines which operates within a system or organization.\n * `SCIM` - A protocol for managing user identities across multiple domains.\n * `AD` - Refers to Active Directory, a directory service for Windows domain networks.\n * `AAD` - Denotes Azure Active Directory, Microsoft's cloud-based identity and access management service.\n * `BROADWORKS` - A platform for delivering telephony and Unified Communications services.\n * `OKTA` - A cloud-based identity management service.\n * `role` - Defines a set of permissions or responsibilities assigned to a user or group within a system.\n * `id_user_admin` - An identifier for a user with administrative privileges.\n * `id_readonly_admin` - An identifier for an admin with read-only access, unable to make changes.\n * `id_device_admin` - An identifier for an admin responsible for managing devices.\n * `id_full_admin` - An identifier for an admin with full access and privileges within a system.\n * `user` - Denotes an individual with access credentials to interact with a system or application.\n * `unique_flat_static` - Represents a unique, non-hierarchical, and unchanging value or setting.\n * `dynamic` - Indicates a value or entity that changes or adapts based on conditions or inputs.\n * `flat_static` - Refers to non-hierarchical and unchanging data or structure.\n * `nested_static` - Implies a hierarchical and unchanging structure or data.\n * `compliance` - transient - Temporary status or condition related to compliance.\n * `pending` - transient - Temporary status indicating an action or decision is awaiting completion.\n * `marked_deleted` - Status indicating an entity is flagged for deletion but not yet removed.\n * `transient` - Denotes temporary or short-lived status or condition.\n * `fraud` - transient - Temporary status relating to suspected fraudulent activity.\n * `active` - Status indicating an entity is currently in use or operational.\n * `disabled` - Status indicating an entity is deactivated or not operational.\n * `suspended` - Status indicating an entity is temporarily inactive or halted.\n * `facebook` - Relates to integration or interaction with the Facebook platform.\n * `O365` - Refers to Office 365, a cloud-based suite of productivity applications from Microsoft.\n * `google` - Relates to integration or interaction with Google services or platforms.\n * `cco` - Cisco Connection Online, a portal for Cisco customers and partners.\n * `enterprise` - Denotes a business or organizational environment, often large-scale.\n * `cloud` - calling - Refers to telephony services delivered via cloud infrastructure.\n * `personal` - room - A virtual space designated for individual use, often for meetings or collaboration.\n * `Everyone` - A designation that includes all users or entities within a system or context.\n * `Internal` - Refers to entities or communications within an organization.\n * `Hidden` - Indicates an entity or setting that is not visible or accessible by default.\n * `Global` - Pertains to settings or entities that apply universally across a system or organization.\n * `phone` - Denotes communication via telephone or telephone numbers.\n * `partner` - upn - User Principal Name used by a partner organization.\n * `email` - Refers to electronic mail addresses or communications.\n * `ciRole` - A specific role related to Cisco Identity.\n * `serviceRole` - A role associated with a particular service or function within a system.\n * `globalRole` - A role with permissions or responsibilities that apply across an entire system or organization.\n * `other` - A category for values or entities that do not fit predefined categories.\n * `work` - Denotes professional or business-related context or communications.\n * `room` - Refers to physical or virtual spaces designated for meetings or collaboration.\n * `home` - Indicates a residential or personal context or setting.\n * `external_calling` - Refers to calls made outside an internal network or organization.\n * `calling_service` - A service dedicated to managing voice communications.\n * `alternate1` - Additional contact methods or backup communication channels.\n * `mobile` - Pertains to mobile phones or communications via mobile networks.\n * `work_extension` - A telephone extension associated with a workplace.\n * `fax` - Refers to facsimile communications or numbers.\n * `alternate2` - Additional contact methods or backup communication channels.\n * `qq` - Denote integration or interaction with various instant messaging or communication platforms.\n * `aim` - Denote integration or interaction with various instant messaging or communication platforms.\n * `cucm` - jid - Jabber IDs used within Cisco Unified Communications Manager or Webex platforms.\n * `webex` - squared-jid - Jabber IDs used within Cisco Unified Communications Manager or Webex platforms.\n * `msn` - Denote integration or interaction with various instant messaging or communication platforms.\n * `xmpp` - Denote integration or interaction with various instant messaging or communication platforms.\n * `skype` - Denote integration or interaction with various instant messaging or communication platforms.\n * `gtalk` - Denote integration or interaction with various instant messaging or communication platforms.\n * `icq` - Denote integration or interaction with various instant messaging or communication platforms.\n * `yahoo` - Denote integration or interaction with various instant messaging or communication platforms.\n * `microsoft` - sip-uri - Session Initiation Protocol Uniform Resource Identifier used by Microsoft services.\n * `thumbnail` - A small image representation of a larger picture.\n * `resizable` - Indicates an image or element that can be adjusted in size.\n * `photo` - Refers to an image or picture, often used for profile or identification purposes.\n"
},
"PatchUser": {
"type": "object",
"required": [
"schemas",
"Operations"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:ietf:params:scim:api:messages:2.0:PatchOp"
},
"description": "Input JSON schemas."
},
"Operations": {
"type": "array",
"items": {
"type": "object",
"required": [
"op"
],
"properties": {
"op": {
"type": "string",
"enum": [
"add",
"replace",
"remove"
],
"description": "The operation to perform."
},
"path": {
"type": "string",
"example": "displayName",
"description": "A string containing an attribute path describing the target of the operation."
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleObject"
},
"description": "New value."
}
}
},
"description": "A list of patch operations."
}
}
},
"PostUser": {
"type": "object",
"required": [
"schemas",
"userName",
"userType"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:ietf:params:scim:schemas:core:2.0:User,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,urn:scim:schemas:extension:cisco:webexidentity:2.0:User"
},
"description": "Input JSON schemas."
},
"userName": {
"type": "string",
"example": "user1@example.com",
"description": "A unique identifier for the user that authenticates the user in Webex. This must be set to the user's primary email address. No other user in Webex may have the same `userName` value, so this value must be unique within Webex."
},
"userType": {
"$ref": "#/components/schemas/UserTypeObject",
"description": "User type."
},
"title": {
"type": "string",
"example": "Sales manager",
"description": "The user's business title. Examples of a title is \"Business Manager\". \"Senior Accountant\", \"Engineer\" etc."
},
"active": {
"type": "boolean",
"example": true,
"description": "A boolean value of \"true\" or \"false\" indicating whether the user is allowed to login to Webex."
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleObject"
},
"description": "List of roles assigned to the user."
},
"preferredLanguage": {
"type": "string",
"example": "en_US",
"description": "User's preferred language. Acceptable values are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter language code followed by an _ and then the 2 letter country code. Examples are:\n\n en_US : for United States English or fr_FR for Parisian French."
},
"locale": {
"type": "string",
"example": "en_US",
"description": "The user's locale which represents the user's currency, time format, and numerical representations. Acceptable values are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter language code followed by an _ and then the 2 letter country code. Examples are:\n\n en_US : for United States English or fr_FR for Parisian French."
},
"timezone": {
"type": "string",
"example": "America/Los_Angeles",
"description": "The user's time zone specified in the [IANA timezone](https://nodatime.org/timezones) timezone format, for example, \"America/Los_Angeles\"."
},
"profileUrl": {
"type": "string",
"example": "https://jojowiki.com/Jonathan_Joestar",
"description": "A fully qualified URL pointing to a page representing the user's online profile."
},
"externalId": {
"type": "string",
"example": "externalIdValue",
"description": "User identifier provided by an external provisioning source."
},
"displayName": {
"type": "string",
"example": "Mr. Jonathan Jane Joestar, III",
"description": "The name displayed for the user in Webex."
},
"nickName": {
"type": "string",
"example": "JoJo",
"description": "A casual name of the user. For example, Bob when the user's formal name is Robert."
},
"name": {
"$ref": "#/components/schemas/NameObject",
"description": "The components of the user's real name."
},
"phoneNumbers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PhoneNumberObject"
},
"description": "A list of user's phone numbers."
},
"photos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PhotoObject"
},
"description": "A list of photo objects for the user."
},
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressObject"
},
"description": "User's physical mailing address."
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailObject"
},
"description": "A list of the user's email addresses, including primary and alternative emails. The primary work email address must match the value of the user's username."
},
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"type": "object",
"properties": {
"costCenter": {
"type": "string",
"example": "costCenter 123",
"description": "Name of a cost center."
},
"organization": {
"type": "string",
"example": "Cisco webexidentity",
"description": "Name of an organization."
},
"division": {
"type": "string",
"example": "division 456",
"description": "Name of a division."
},
"department": {
"type": "string",
"example": "department 789",
"description": "Name of a department."
},
"employeeNumber": {
"type": "string",
"example": "518-8888-888",
"description": "Numeric or alphanumeric identifier assigned to a person, typically based on the order of hire or association with an organization."
},
"manager": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "b5717a4a-0169-43b2-ac3c-db20ba4e72cd",
"description": "Webex Identity assigned user identifier of the user's manager. The manager must belong to the same org as the user."
}
},
"description": "The user's manager."
}
},
"description": "SCIM2 enterprise extension"
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User": {
"type": "object",
"required": [
"accountStatus"
],
"properties": {
"accountStatus": {
"$ref": "#/components/schemas/AccountStatusObject",
"description": "An array of additional information about a user's status."
},
"sipAddresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SipAddressObject"
},
"description": "`sipAddress` values for the user."
},
"managedOrgs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManagedOrgsObject"
},
"description": "Organizations that the user can manage."
},
"managedGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManagedGroupsObject"
},
"description": "Groups that the user can manage."
},
"extensionAttribute*": {
"type": "array",
"items": {
"type": "string"
},
"description": "The extension attributes of the user. Postfix support from 1 to 15, for example: \"extensionAttribute1\", \"extensionAttribute2\", ..., \"extensionAttribute15\"."
},
"externalAttribute*": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalAttributeObject"
},
"description": "The external attributes of the user. Postfix support from 1 to 15, for example: \"externalAttribute1\", \"externalAttribute2\", ..., \"externalAttribute15\"."
}
},
"description": "The Cisco extension of SCIM 2."
}
}
},
"PutUser": {
"type": "object",
"required": [
"schemas",
"userName",
"userType"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:ietf:params:scim:schemas:core:2.0:User,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,urn:scim:schemas:extension:cisco:webexidentity:2.0:User"
},
"description": "Input JSON schemas."
},
"userName": {
"type": "string",
"example": "user1Changed@example.com",
"description": "A unique identifier for the user and authenticates the user in Webex. This must be set to the user's primary email address. No other user in Webex may have the same `userName` value and thus this value is required to be unique within Webex."
},
"userType": {
"$ref": "#/components/schemas/UserTypeObject",
"description": "User type."
},
"title": {
"type": "string",
"example": "Sales manager",
"description": "The user's business title. Examples of a title is \"Business Manager\". \"Senior Accountant\", \"Engineer\" etc."
},
"active": {
"type": "boolean",
"example": true,
"description": "A boolean value of \"true\" or \"false\" indicating whether the user is allowed to login to Webex."
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleObject"
},
"description": "List of roles assigned to the user."
},
"preferredLanguage": {
"type": "string",
"example": "en_US",
"description": "User's preferred language. Acceptable values for this field are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter language code followed by an _ and then the 2 letter country code. Examples are:\n\n en_US : for United States English or fr_FR for Parisian French."
},
"locale": {
"type": "string",
"example": "en_US",
"description": "The user's locale which represents the user's currency, time format, and numerical representations. Acceptable values are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter language code followed by an _ and then the 2 letter country code. Examples are:\n\n en_US : for United States English or fr_FR for Parisian French."
},
"timezone": {
"type": "string",
"example": "America/Los_Angeles",
"description": "The user's time zone specified in the [IANA timezone](https://nodatime.org/timezones) timezone format. e.g: \"America/Los_Angeles\"."
},
"profileUrl": {
"type": "string",
"example": "https://jojowiki.com/Jonathan_Joestar",
"description": "A fully qualified URL pointing to a page representing the user's online profile."
},
"externalId": {
"type": "string",
"example": "externalIdNewValue",
"description": "User identifier provided by an external provisioning source."
},
"displayName": {
"type": "string",
"example": "Mr. Jonathan Jane Joestar, III",
"description": "The name displayed for the user in Webex."
},
"nickName": {
"type": "string",
"example": "JoJo",
"description": "A casual name of the user. For example, Bob when the user's formal name is Robert."
},
"phoneNumbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "400 123 1234",
"description": "phone number."
},
"type": {
"type": "string",
"enum": [
"work",
"home",
"mobile",
"work_extension",
"fax",
"pager",
"other"
],
"description": "We support the following phone number types: 'mobile', 'work', 'fax', 'work_extension', 'alternate1', 'alternate2'. Alternate 1 and Alternate 2 are types inherited from Webex meeting sites."
},
"display": {
"type": "string",
"example": "work phone number",
"description": "A human-readable name, primarily used for display purposes."
},
"primary": {
"type": "boolean",
"example": true,
"description": "A Boolean value indicating the phone number's primary status."
}
}
},
"description": "A list of user's phone numbers."
},
"photos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PhotoObject"
},
"description": "A list of photo objects for the user."
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "work",
"description": "address type"
},
"streetAddress": {
"type": "string",
"example": "100 Universal City Plaza",
"description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. This attribute MAY contain newlines."
},
"locality": {
"type": "string",
"example": "Hollywood",
"description": "The city or locality component."
},
"region": {
"type": "string",
"example": "CA",
"description": "The state or region component."
},
"postalCode": {
"type": "string",
"example": "91608",
"description": "The zip code or postal code component."
},
"country": {
"type": "string",
"example": "US",
"description": "The country name component."
}
}
},
"description": "User's physical mailing address."
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailObject"
},
"description": "A list of the user's email addresses, including primary and alternative emails. The primary work email address must match the value of the user's username."
},
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"type": "object",
"properties": {
"costCenter": {
"type": "string",
"example": "costCenter 123",
"description": "Name of a cost center."
},
"organization": {
"type": "string",
"example": "Cisco webexidentity",
"description": "Name of an organization."
},
"division": {
"type": "string",
"example": "division 456",
"description": "Name of a division."
},
"department": {
"type": "string",
"example": "department 789",
"description": "Name of a department."
},
"employeeNumber": {
"type": "string",
"example": "518-8888-888",
"description": "Numeric or alphanumeric identifier assigned to a person, typically based on the order of hire or association with an organization."
},
"manager": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "b5717a4a-0169-43b2-ac3c-db20ba4e72cd",
"description": "Webex Identity assigned user identifier of the user's manager. The manager must belong to the same org as the user."
}
},
"description": "The user's manager."
}
},
"description": "SCIM2 enterprise extension"
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User": {
"type": "object",
"required": [
"accountStatus"
],
"properties": {
"accountStatus": {
"$ref": "#/components/schemas/AccountStatusObject",
"description": "An array of additional information about a user's status."
},
"sipAddresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SipAddressObject"
},
"description": "`sipAddress` values for the user."
},
"managedOrgs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManagedOrgsObject"
},
"description": "Organizations that the user can manage."
},
"managedGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManagedGroupsObject"
},
"description": "Groups that the user can manage."
},
"extensionAttribute*": {
"type": "array",
"items": {
"type": "string"
},
"description": "The extension attributes of the user. Postfix support from 1 to 15, for example: \"extensionAttribute1\", \"extensionAttribute2\", ..., \"extensionAttribute15\"."
},
"externalAttribute*": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalAttributeObject"
},
"description": "The external attributes of the user. Postfix support from 1 to 15, for example: \"externalAttribute1\", \"externalAttribute2\", ..., \"externalAttribute15\"."
}
},
"description": "cisco extension of SCIM 2"
}
}
},
"GetUserResponse": {
"type": "object",
"required": [
"schemas",
"id",
"userName",
"userType",
"meta"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:ietf:params:scim:schemas:core:2.0:User,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,urn:scim:schemas:extension:cisco:webexidentity:2.0:User"
},
"description": "Input JSON schemas."
},
"id": {
"type": "string",
"example": "3426a8e3-d414-4bf0-a493-4f6787632a13",
"description": "Webex Identity assigned user identifier."
},
"userName": {
"type": "string",
"example": "user1@example.com",
"description": "A unique identifier for the user and authenticates the user in Webex. This must be set to the user's primary email address. No other user in Webex may have the same `userName` value and thus this value is required to be unique within Webex."
},
"active": {
"type": "boolean",
"example": true,
"description": "A boolean value of \"true\" or \"false\" indicating whether the user is allowed to login in Webex."
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleObject"
},
"description": "List of roles assigned to the user."
},
"name": {
"$ref": "#/components/schemas/NameObject",
"description": "The components of the user's real name."
},
"displayName": {
"type": "string",
"example": "Mr. Jonathan Jane Joestar, III",
"description": "The name displayed for the user in Webex."
},
"nickName": {
"type": "string",
"example": "JoJo",
"description": "A casual name of the user. For example, Bob when the user's formal name is Robert."
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailObject"
},
"description": "A list of the user's email addresses, including primary and alternative emails. The primary work email address must match the value of the user's username."
},
"userType": {
"$ref": "#/components/schemas/UserTypeObject",
"description": "User type."
},
"profileUrl": {
"type": "string",
"example": "https://jojowiki.com/Jonathan_Joestar",
"description": "A fully qualified URL pointing to a page representing the user's online profile."
},
"title": {
"type": "string",
"example": "Sales manager",
"description": "The user's business title. Examples of a title is \"Business Manager\". \"Senior Accountant\", \"Engineer\" etc."
},
"preferredLanguage": {
"type": "string",
"example": "en_US",
"description": "User's preferred language. Acceptable values for this field are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter language code followed by an _ and then the 2 letter country code. Examples are:\n\n en_US : for United States English or fr_FR for Parisian French."
},
"locale": {
"type": "string",
"example": "en_US",
"description": "The user's locale which represents the user's currency, time format, and numerical representations. Acceptable values for this field are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter language code followed by an _ and then the 2 letter country code. Examples are:\n\n en_US : for United States English or fr_FR for Parisian French."
},
"externalId": {
"type": "string",
"example": "externalIdValue",
"description": "User identifier provided by an external provisioning source."
},
"timezone": {
"type": "string",
"example": "America/Los_Angeles",
"description": "The user's time zone specified in the [IANA timezone](https://nodatime.org/timezones) timezone format, for example, \"America/Los_Angeles\"."
},
"phoneNumbers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PhoneNumberObject"
},
"description": "A list of user's phone numbers."
},
"photos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PhotoObject"
},
"description": "A list of photo objects for the user."
},
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressObject"
},
"description": "User's physical mailing address."
},
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"type": "object",
"properties": {
"costCenter": {
"type": "string",
"example": "costCenter 123",
"description": "Name of a cost center."
},
"organization": {
"type": "string",
"example": "Cisco webexidentity",
"description": "Name of an organization."
},
"division": {
"type": "string",
"example": "division 456",
"description": "Name of a division."
},
"department": {
"type": "string",
"example": "department 789",
"description": "Name of a department."
},
"employeeNumber": {
"type": "string",
"example": "518-8888-888",
"description": "Numeric or alphanumeric identifier assigned to a person, typically based on the order of hire or association with an organization."
},
"manager": {
"$ref": "#/components/schemas/ManagerResponseObject",
"description": "The user's manager."
}
},
"description": "SCIM2 enterprise extension"
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User": {
"type": "object",
"required": [
"accountStatus"
],
"properties": {
"accountStatus": {
"$ref": "#/components/schemas/AccountStatusObject",
"description": "An array of additional information about a user's status."
},
"sipAddresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SipAddressObject"
},
"description": "`sipAddress` values for the user."
},
"managedOrgs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManagedOrgsObject"
},
"description": "Organizations that the user can manage."
},
"managedGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManagedGroupsObject"
},
"description": "Groups that the user can manage."
},
"extensionAttribute*": {
"type": "array",
"items": {
"type": "string"
},
"description": "The extension attributes of the user. Postfix support from 1 to 15, for example: \"extensionAttribute1\", \"extensionAttribute2\", ..., \"extensionAttribute15\"."
},
"externalAttribute*": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalAttributeObject"
},
"description": "The external attributes of the user. Postfix support from 1 to 15, for example: \"externalAttribute1\", \"externalAttribute2\", ..., \"externalAttribute15\"."
}
},
"description": "The Cisco extension of SCIM 2."
},
"meta": {
"$ref": "#/components/schemas/MetaObject",
"description": "Response metadata."
}
}
},
"SearchGetUserResponse": {
"type": "object",
"required": [
"schemas",
"id",
"userName",
"userType",
"meta"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:ietf:params:scim:schemas:core:2.0:User,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,urn:scim:schemas:extension:cisco:webexidentity:2.0:User"
},
"description": "Input JSON schemas."
},
"id": {
"type": "string",
"example": "3426a8e3-d414-4bf0-a493-4f6787632a13",
"description": "Webex Identity assigned user identifier."
},
"userName": {
"type": "string",
"example": "user1@example.com",
"description": "A unique identifier for the user and authenticates the user in Webex. This must be set to the user's primary email address. No other user in Webex may have the same `userName` value and thus is required to be unique within Webex."
},
"active": {
"type": "boolean",
"example": true,
"description": "A boolean value of \"true\" or \"false\" indicating whether the user is allowed to login in Webex."
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleObject"
},
"description": "List of roles assigned to the user."
},
"name": {
"$ref": "#/components/schemas/NameObject",
"description": "The components of the user's real name."
},
"displayName": {
"type": "string",
"example": "Mr. Jonathan Jane Joestar, III",
"description": "The name displayed for the user in Webex."
},
"nickName": {
"type": "string",
"example": "JoJo",
"description": "A casual name of the user. For example, Bob when the user's formal name is Robert."
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailObject"
},
"description": "A list of the user's email addresses, including primary and alternative emails. The primary work email address must match the value of the user's username."
},
"userType": {
"$ref": "#/components/schemas/UserTypeObject",
"description": "User type."
},
"profileUrl": {
"type": "string",
"example": "https://jojowiki.com/Jonathan_Joestar",
"description": "A fully qualified URL pointing to a page representing the user's online profile."
},
"title": {
"type": "string",
"example": "Sales manager",
"description": "The user's business title. Examples of a title is \"Business Manager\". \"Senior Accountant\", \"Engineer\" etc."
},
"preferredLanguage": {
"type": "string",
"example": "en_US",
"description": "User's preferred language. Acceptable values are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter language code followed by an _ and then the 2 letter country code. Examples are:\n\n en_US : for United States English or fr_FR for Parisian French."
},
"locale": {
"type": "string",
"example": "en_US",
"description": "The user's locale which represents the user's currency, time format, and numerical representations. Acceptable values are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter language code followed by an _ and then the 2 letter country code. Examples are:\n\n en_US : for United States English or fr_FR for Parisian French."
},
"externalId": {
"type": "string",
"example": "externalIdValue",
"description": "User identifier provided by an external provisioning source."
},
"timezone": {
"type": "string",
"example": "America/Los_Angeles",
"description": "The user's time zone specified in the [IANA timezone](https://nodatime.org/timezones) timezone format, for example, \"America/Los_Angeles\"."
},
"phoneNumbers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PhoneNumberObject"
},
"description": "A list of user's phone numbers."
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupObject"
},
"description": "A list of group details returned only when `includeGroupDetails` or `returnGroups` request parameters are set to true."
},
"photos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PhotoObject"
},
"description": "A list of photo objects for the user."
},
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressObject"
},
"description": "User's physical mailing address."
},
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"type": "object",
"properties": {
"costCenter": {
"type": "string",
"example": "costCenter 123",
"description": "Name of a cost center."
},
"organization": {
"type": "string",
"example": "Cisco webexidentity",
"description": "Name of an organization."
},
"division": {
"type": "string",
"example": "division 456",
"description": "Name of a division."
},
"department": {
"type": "string",
"example": "department 789",
"description": "Name of a department."
},
"employeeNumber": {
"type": "string",
"example": "518-8888-888",
"description": "Numeric or alphanumeric identifier assigned to a person, typically based on the order of hire or association with an organization."
},
"manager": {
"$ref": "#/components/schemas/ManagerResponseObject",
"description": "The user's manager."
}
},
"description": "SCIM2 enterprise extension"
},
"urn:scim:schemas:extension:cisco:webexidentity:2.0:User": {
"type": "object",
"required": [
"accountStatus"
],
"properties": {
"accountStatus": {
"$ref": "#/components/schemas/AccountStatusObject",
"description": "An array of additional information about a user's status."
},
"sipAddresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SipAddressObject"
},
"description": "`sipAddress` values for the user."
},
"managedOrgs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManagedOrgsObject"
},
"description": "Organizations that the user can manage."
},
"managedGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ManagedGroupsObject"
},
"description": "Groups that the user can manage."
},
"extensionAttribute*": {
"type": "array",
"items": {
"type": "string"
},
"description": "The extension attributes of the user. Postfix support from 1 to 15, for example: \"extensionAttribute1\", \"extensionAttribute2\", ..., \"extensionAttribute15\"."
},
"externalAttribute*": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalAttributeObject"
},
"description": "The external attributes of the user. Postfix support from 1 to 15, for example: \"externalAttribute1\", \"externalAttribute2\", ..., \"externalAttribute15\"."
}
},
"description": "The Cisco extension of SCIM 2."
},
"meta": {
"$ref": "#/components/schemas/MetaObject",
"description": "Response metadata."
}
}
},
"RoleObject": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "id_full_admin",
"description": "CI Role"
},
"type": {
"type": "string",
"example": "cirole",
"description": "name"
},
"display": {
"type": "string",
"example": "Full Administrator",
"description": "A human-readable name, primarily used for display purposes."
}
}
},
"AccountStatusObject": {
"type": "string",
"description": "An array of additional information about a user's status.",
"enum": [
"active",
"pending",
"transient",
"disabled",
"fraud",
"fraud_transient",
"compliance_transient",
"pending_transient"
]
},
"UserTypeObject": {
"type": "string",
"enum": [
"user",
"room",
"external_calling",
"calling_service"
]
},
"PhoneNumberObject": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "400 123 1234",
"description": "phone number."
},
"type": {
"type": "string",
"enum": [
"work",
"home",
"mobile",
"work_extension",
"fax",
"pager",
"other"
],
"description": "We support the following phone number types: 'mobile', 'work', 'fax', 'work_extension', 'alternate1', 'alternate2'. Alternate 1 and Alternate 2 are types inherited from Webex meeting sites."
},
"display": {
"type": "string",
"example": "work phone number",
"description": "A human-readable name, primarily used for display purposes."
},
"primary": {
"type": "boolean",
"example": true,
"description": "A Boolean value for phone number's primary status."
}
}
},
"PhotoObject": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "https://photos.example.com/profilephoto/72930000000Ccne/F",
"description": "photo link."
},
"type": {
"type": "string",
"enum": [
"photo",
"thumbnail",
"resizable"
],
"description": "The type of the photo"
},
"display": {
"type": "string",
"example": "photo description",
"description": "A human-readable description, primarily used for display purposes."
},
"primary": {
"type": "boolean",
"example": true,
"description": "A Boolean value for the photo usage status."
}
}
},
"GroupObject": {
"type": "object",
"properties": {
"value": {
"type": "string",
"example": "11d0ec88-04b9-4ece-9f28-06e1d7673ee3",
"description": "A unique identifier for the group."
},
"display": {
"type": "string",
"example": "Darmstadt",
"description": "Display name of the group."
},
"$ref": {
"type": "string",
"example": "https://webexapis.com/identity/scim/36818b6f-ef07-43d1-b76f-ced79ab2e3e7/v2/Groups/11d0ec88-04b9-4ece-9f28-06e1d7673ee3",
"description": "The URI corresponding to a group."
}
}
},
"AddressObject": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "work",
"description": "The type of the address."
},
"streetAddress": {
"type": "string",
"example": "100 Universal City Plaza",
"description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. This attribute MAY contain newlines."
},
"locality": {
"type": "string",
"example": "Hollywood",
"description": "The city or locality component."
},
"region": {
"type": "string",
"example": "CA",
"description": "The state or region component."
},
"postalCode": {
"type": "string",
"example": "91608",
"description": "The zip code or postal code component."
},
"country": {
"type": "string",
"example": "US",
"description": "The country name component."
}
}
},
"ManagerResponseObject": {
"type": "object",
"description": "The user's manager.",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "b5717a4a-0169-43b2-ac3c-db20ba4e72cd",
"description": "Webex Identity assigned user identifier of the user's manager. The manager must belong to the same org as the user."
},
"displayName": {
"type": "string",
"example": "Identity Administrator",
"description": "The name displayed for the manager in Webex."
},
"$ref": {
"type": "string",
"example": "https://integration.webexapis.com/identity/scim/0ae87ade-8c8a-4952-af08-318798958d0c/v2/Users/b5717a4a-0169-43b2-ac3c-db20ba4e72cd",
"description": "The URI corresponding to a SCIM user that is the manager."
}
}
},
"SipAddressObject": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "sipAddress value1",
"description": "The `sipAddress` value."
},
"type": {
"type": "string",
"enum": [
"enterprise"
],
"description": "`sipAddress` type."
},
"display": {
"type": "string",
"example": "sipAddress1 description",
"description": "A human-readable description, primarily used for display purposes."
},
"primary": {
"type": "boolean",
"example": true,
"description": "Designate the primary `sipAddress`."
}
}
},
"ManagedOrgsObject": {
"type": "object",
"required": [
"orgId",
"role"
],
"properties": {
"orgId": {
"type": "string",
"example": "75fe2995-24f5-4831-8d2c-1c2f8255912e",
"description": "Webex Identity assigned organization identifier."
},
"role": {
"type": "string",
"example": "id_full_admin",
"description": "Role in the target organization for the user."
}
}
},
"ManagedGroupsObject": {
"type": "object",
"required": [
"orgId",
"groupId",
"role"
],
"properties": {
"orgId": {
"type": "string",
"example": "0ae87ade-8c8a-4952-af08-318798958d0c",
"description": "Webex Identity assigned organization identifier."
},
"groupId": {
"type": "string",
"example": "3936af3e-15ff-43d1-9ef5-66c569ef34f5",
"description": "Webex Identity assigned group identifier."
},
"role": {
"type": "string",
"example": "location_admin",
"description": "Role in the target group for the user."
}
}
},
"ExternalAttributeObject": {
"type": "object",
"required": [
"source",
"value"
],
"properties": {
"source": {
"type": "string",
"example": "Source.1_7ddf1f2c-2985-4c37-a450-d58bbc201750",
"description": "Source of external attribute."
},
"value": {
"type": "string",
"example": "externalAttribute1_value",
"description": "Value of external attribute."
}
}
},
"ManagedSitesObject": {
"type": "object",
"required": [
"siteName",
"role"
],
"properties": {
"siteName": {
"type": "string",
"example": "admintrainSiteName1.webex.com",
"description": "Managed site name."
},
"role": {
"type": "string",
"example": "full_admin",
"description": "Role in the managed site for the user."
}
}
},
"ManagedGroupObject": {
"type": "object",
"required": [
"orgId",
"groupId",
"role"
],
"properties": {
"orgId": {
"type": "string",
"example": "153ced48-d2d1-4369-86fd-9b9fade218ff",
"description": "Webex Identity assigned organization identifier."
},
"groupId": {
"type": "string",
"example": "1929effd-b750-43d6-be0d-7dcdaac38e92",
"description": "A unique identifier for the group."
},
"role": {
"type": "string",
"example": "location_full_admin",
"description": "Role in the target organization for the user."
}
}
},
"SearchUserResponse": {
"type": "object",
"required": [
"schemas"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "string",
"example": "urn:ietf:params:scim:api:messages:2.0:ListResponse"
},
"description": "Input JSON schemas."
},
"totalResults": {
"type": "number",
"example": 2,
"description": "Total number of users in search results."
},
"itemsPerPage": {
"type": "number",
"example": 2,
"description": "The total number of items in a paged result."
},
"startIndex": {
"type": "number",
"example": 1,
"description": "Start at the one-based offset in the list of matching users."
},
"Resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchGetUserResponse"
},
"description": "A list of users with details."
}
}
},
"SecurityAuditEventCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SecurityAuditEvent"
},
"description": "array of monitoring Audit events"
}
}
},
"SecurityAuditEvent": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"actorOrgName": {
"type": "string",
"example": "Acme Inc.",
"description": "The display name of the organization."
},
"eventDescription": {
"type": "string",
"example": "An Admin logged in",
"description": "A description for the event."
},
"actorName": {
"type": "string",
"example": "Joe Smith",
"description": "The name of the person who performed the action."
},
"actorEmail": {
"type": "string",
"example": "joe@example.com",
"description": "The email of the person who performed the action."
},
"actorUserAgent": {
"type": "string",
"example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
"description": "The browser user agent of the person who performed the action."
},
"trackingId": {
"type": "string",
"example": "ATLAS_6f23a878-bcd4-c204-a4db-e701b42b0e5c_0",
"description": "A tracking identifier for the event."
},
"eventCategory": {
"type": "string",
"example": "LOGINS",
"description": "The category of resource changed by the event."
},
"actorIp": {
"type": "string",
"example": "128.107.241.191",
"description": "The IP address of the person who performed the action."
},
"actionText": {
"type": "string",
"example": "Joe Smith logged into organization Acme Inc.",
"description": "A more detailed description of the change made by the person."
}
}
},
"created": {
"type": "string",
"example": "2019-01-02T16:58:36.845Z",
"description": "The date and time the event took place."
},
"actorOrgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The `orgId` of the person who made the change."
},
"id": {
"type": "string",
"example": "MjQ0ODhiZTYtY2FiMS00ZGRkLTk0NWQtZDFlYjkzOGQ4NGUy",
"description": "A unique identifier for the event."
},
"actorId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZWVmOGE4ZS1lNzg3LTQzMWUtOWM3ZC1hOGVjZmU1MjM5Nzc",
"description": "The `personId` of the person who made the change."
}
}
},
"BulkActivationEmailResendJobDetails": {
"type": "object",
"required": [
"name",
"id",
"trackingId",
"sourceUserId",
"sourceCustomerId",
"targetCustomerId",
"instanceId",
"latestExecutionStatus",
"counts"
],
"properties": {
"name": {
"type": "string",
"description": "Job name."
},
"id": {
"type": "string",
"description": "Unique identifier of the job."
},
"trackingId": {
"type": "string",
"description": "Unique identifier to track the flow of HTTP requests."
},
"sourceUserId": {
"type": "string",
"description": "Unique identifier to identify which user has run the job."
},
"sourceCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer who has run the job."
},
"targetCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer for which the job was run."
},
"instanceId": {
"type": "number",
"description": "Unique identifier to identify the instance of the job."
},
"jobExecutionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StepExecutionStatus"
},
"description": "Contains the execution statuses of all the steps involved in the execution of the job."
},
"latestExecutionStatus": {
"$ref": "#/components/schemas/ExecutionStatus",
"description": "Indicates the most recent status of the job at the time of invocation."
},
"latestExecutionExitCode": {
"type": "string",
"enum": [
"UNKNOWN",
"COMPLETED",
"FAILED",
"STOPPED",
"COMPLETED_WITH_ERRORS"
],
"description": "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n"
},
"counts": {
"$ref": "#/components/schemas/BulkActivationEmailResendJobCounts",
"description": "Summary of statuses."
},
"allowAdminInviteEmails": {
"type": "boolean",
"description": "Indicates if the org allows admin invite emails to be sent."
}
}
},
"BulkActivationEmailResendJobCounts": {
"type": "object",
"required": [
"userResendInviteSent",
"userResendInviteFailed",
"userResendInviteSkipped",
"totalUsers"
],
"properties": {
"userResendInviteSent": {
"type": "number",
"description": "Count of users sent an invitation."
},
"userResendInviteFailed": {
"type": "number",
"description": "Count of users who failed to receive an invitation."
},
"userResendInviteSkipped": {
"type": "number",
"description": "Count of users who were skipped."
},
"totalUsers": {
"type": "number",
"description": "Total count of users processed."
}
}
},
"ExecutionStatus": {
"type": "string",
"enum": [
"COMPLETED",
"STARTING",
"STARTED",
"STOPPING",
"FAILED",
"ABANDONED",
"UNKNOWN"
],
"description": " * `COMPLETED` - Step or job has completed.\n * `STARTING` - Step or job is starting.\n * `STARTED` - Step or job is running.\n * `STOPPING` - Step or job is stopping.\n * `FAILED` - Step or job has failed with an error.\n * `ABANDONED` - Step or job has been abandone (manually stopped).\n * `UNKNOWN` - Step or job status is unknown.\n"
},
"JobExecutionStatus": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Unique identifier for each instance of the job."
},
"startTime": {
"type": "string",
"description": "Job execution start time in UTC format."
},
"endTime": {
"type": "string",
"description": "Job execution end time in UTC format."
},
"lastUpdated": {
"type": "string",
"description": "Last time the job's execution status was updated in UTC format."
},
"statusMessage": {
"$ref": "#/components/schemas/ExecutionStatus",
"description": "Displays status for overall steps that are part of the job."
},
"exitCode ExecutionStatus, optional)": {
"type": "string",
"description": "Final execution status for the job."
},
"createdTime": {
"type": "string",
"description": "Job creation time in UTC format."
},
"timeElapsed": {
"type": "string",
"description": "Time lapsed since the job execution started."
},
"stepExecutionStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StepExecutionStatus"
},
"description": "Status of each step within a job."
}
}
},
"StepExecutionStatus": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Unique identifier of the step"
},
"startTime": {
"type": "string",
"description": "Step execution start time in UTC format."
},
"endTime": {
"type": "string",
"description": "Step execution end time in UTC format."
},
"lastUpdated": {
"type": "string",
"description": "Last time the step's execution status was updated in UTC format."
},
"statusMessage": {
"$ref": "#/components/schemas/ExecutionStatus",
"description": "Displays the most recent execution status of the step."
},
"exitCode": {
"$ref": "#/components/schemas/ExecutionStatus",
"description": "Final execution status of the step."
},
"name": {
"type": "string",
"description": "Step name."
},
"timeElapsed": {
"type": "string",
"description": "Time elapsed since the step execution started."
}
}
},
"Error": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Human-readable error message",
"example": "Invalid client credentials"
},
"trackingId": {
"type": "string",
"description": "Unique identifier for tracking this error",
"example": "ROUTER_1234567890ABCDEF"
},
"errors": {
"type": "array",
"description": "Detailed list of validation errors",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Description of the specific error",
"example": "clientSecret is required"
}
}
},
"example": [
{
"description": "clientSecret is required"
}
]
}
},
"example": {
"message": "Invalid client credentials",
"trackingId": "ROUTER_1234567890ABCDEF",
"errors": [
{
"description": "The provided clientSecret is invalid"
}
]
}
},
"getOrgSettingResponse": {
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "allow-admin-invite-emails",
"description": "Key of the setting."
},
"value": {
"type": "boolean",
"description": "Value of the setting."
},
"name": {
"type": "string",
"example": "Automatic Activation Emails",
"description": "Name of the setting."
}
}
},
"updateOrgSettingObject": {
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "allow-admin-invite-emails",
"description": "Key of the setting."
},
"value": {
"type": "boolean",
"description": "Value of the setting."
}
}
},
"TagsRequest": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagsObj"
},
"description": "An array of tags."
}
}
},
"TagsObj": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "Tag name",
"description": "Name of the tag."
},
"description": {
"type": "string",
"example": "Tag description",
"description": "Description of the tag"
}
}
},
"CustomerTagsResponse": {
"type": "object",
"properties": {
"orgName": {
"type": "string",
"example": "Customer Name",
"description": "Name of the customer organization."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"description": "The unique identifier for the customer organization."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"example": "Tags1,Tags2"
},
"description": "An array of tags."
}
}
},
"SubscriptionTagsResponse": {
"type": "object",
"properties": {
"orgName": {
"type": "string",
"example": "Customer Name",
"description": "Name of the customer organization."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"description": "The unique identifier for the customer organization."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"example": "Tags1,Tags2"
},
"description": "An array of tags."
},
"subscriptionId": {
"type": "string",
"example": "Sub119911",
"description": "The unique identifier for the subscription."
},
"trial": {
"type": "string",
"example": "false",
"description": "boolean flag for trial or not."
}
}
}
},
"securitySchemes": {
"oauth2": {
"flows": {
"authorizationCode": {
"authorizationUrl": "/",
"scopes": {},
"tokenUrl": "/"
}
},
"type": "oauth2"
},
"bearer-key": {
"type": "http",
"description": "e.g. Bearer YOUR_AUTHORIZATION_TOKEN",
"scheme": "bearer",
"bearerFormat": "JWT"
},
"bearerAuth": {
"type": "oauth2",
"description": "OAuth 2.0 Bearer token authentication",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://webexapis.com/v1/authorize",
"tokenUrl": "https://webexapis.com/v1/access_token",
"scopes": {
"spark:applications_token": "Create access tokens for Service Apps"
}
}
}
}
},
"parameters": {},
"responses": {},
"requestBodies": {}
}
}