{"openapi":"3.0.0","paths":{"/v1/users":{"post":{"description":"Create a new user with access to one or more applications. The created user will be in a `PROVISIONED` status until they activate their account via the activation email.","operationId":"createUser","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreateRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}},"400":{"description":"Bad Request: returned if request validation fails"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found: returned if tenant is not found"},"409":{"description":"Conflict: returned if user already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Create user","tags":["Users"]},"get":{"description":"Query users in the organization. Use `skip` and `limit` to paginate the results.","operationId":"queryUsers","parameters":[{"name":"limit","required":false,"in":"query","description":"Number of results to return","schema":{"default":100,"type":"number"}},{"name":"skip","required":false,"in":"query","description":"Number of results to skip","schema":{"default":0,"type":"number"}},{"name":"orderBy","required":false,"in":"query","description":"Orderby field - defaults to lastName","schema":{"default":"lastName","type":"string"}},{"name":"status","required":false,"in":"query","description":"Accepts an array (status=ACTIVE&status=PROVISIONED) or a comma delimited string (status=ACTIVE,PROVISIONED)","schema":{"type":"array","items":{"$ref":"#/components/schemas/UserStatus"}}},{"name":"app","required":false,"in":"query","schema":{"$ref":"#/components/schemas/BackendApplicationType"}},{"name":"role","required":false,"in":"query","description":"role - user role to return","schema":{"$ref":"#/components/schemas/UserRole"}},{"name":"studioRole","required":false,"in":"query","schema":{"$ref":"#/components/schemas/StudioRole"}},{"name":"searchTerm","required":false,"in":"query","description":"Term to search using","schema":{"type":"string"}},{"name":"searchField","required":false,"in":"query","description":"Field to search for matches on","schema":{"$ref":"#/components/schemas/UserField"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponsePaged"}}}},"400":{"description":"Bad Request: returned if request validation fails"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found: returned if tenant is not found"}},"summary":"Query users","tags":["Users"]}},"/v1/users/{userId}":{"get":{"description":"Get a user by their ID. Returns `404` if the user is not found.","operationId":"getUser","parameters":[{"name":"userId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}},"400":{"description":"Bad Request: returned if request validation fails"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found: returned if tenant or user is not found"}},"summary":"Get user","tags":["Users"]},"patch":{"description":"Update a user by their ID. Only `ACTIVE` users can be updated.","operationId":"updateUser","parameters":[{"name":"userId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdateRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}},"400":{"description":"Bad Request: returned if request validation fails"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found: returned if tenant or user is not found"},"409":{"description":"Conflict: returned if field being updated conflicts with an existing user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"summary":"Update user","tags":["Users"]}},"/v1/users/{userId}/lifecycle/activate":{"post":{"description":"Reactivate an `INACTIVE` user. The user will be in a `PROVISIONED` status until they activate their account via the activation email.","operationId":"activateUser","parameters":[{"name":"userId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"OK: user activated"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found: returned if tenant/user is not found"}},"summary":"Activate user","tags":["Users"]}},"/v1/users/{userId}/lifecycle/deactivate":{"post":{"description":"Deactivate a `PROVISIONED` or `ACTIVE` user.","operationId":"deactivateUser","parameters":[{"name":"userId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"OK: user deactivated"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found: returned if tenant/user is not found"}},"summary":"Deactivate user","tags":["Users"]}},"/v1/users/{userId}/activation-email":{"post":{"description":"Resend the activation email for a `PROVISIONED` user. Returns a `400` if the user is not `PROVISIONED`.","operationId":"resendActivationEmail","parameters":[{"name":"userId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"OK: user activation email sent"},"400":{"description":"Bad Request: returned if request validation fails"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found: returned if tenant/user is not found"}},"summary":"Resend activation email","tags":["Users"]}}},"info":{"title":"User Management API","description":"Manage your organization's users - create, update and manage the lifecycle of users.","version":"v1","contact":{}},"tags":[],"servers":[{"url":"https://api.aforza.com"}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"scopes":{"users.manage":"View, create, update and manage the lifecycle of users"},"tokenUrl":"https://login.aforza.com/oauth2/default/v1/token"}},"name":"oAuth2ClientCredentials","description":"This API uses OAuth 2 with client credentials flow. A Client ID and Client Secret are required to obtain a token."}},"schemas":{"UserRole":{"type":"string","enum":["USER","ADMIN"]},"SupportedLanguage":{"type":"string","enum":["ar","nl","en-GB","fr","de","el","pt","es"]},"Country":{"type":"string","enum":["Afghanistan","Albania","Algeria","Andorra","Angola","Antigua and Barbuda","Argentina","Armenia","Australia","Austria","Azerbaijan","Bahamas","Bahrain","Bangladesh","Barbados","Belarus","Belgium","Belize","Benin","Bhutan","Bolivia","Bosnia and Herzegovina","Botswana","Brazil","Brunei","Bulgaria","Burkina Faso","Burundi","Cabo Verde","Cambodia","Cameroon","Canada","Central African Republic","Chad","Chile","China","Colombia","Comoros","Congo","Democratic Republic of the Congo","Costa Rica","Croatia","Cuba","Cyprus","Czechia","Denmark","Djibouti","Dominica","Dominican Republic","Ecuador","Egypt","El Salvador","Equatorial Guinea","Eritrea","Estonia","Eswatini","Ethiopia","Fiji","Finland","France","Gabon","The Gambia","Georgia","Germany","Ghana","Greece","Grenada","Guatemala","Guinea","Guinea-Bissau","Guyana","Haiti","Honduras","Hungary","Iceland","India","Indonesia","Iran","Iraq","Ireland","Israel","Italy","Jamaica","Japan","Jordan","Kazakhstan","Kenya","Kiribati","North Korea","South Korea","Kuwait","Kyrgyzstan","Laos","Latvia","Lebanon","Lesotho","Liberia","Libya","Liechtenstein","Lithuania","Luxembourg","Madagascar","Malawi","Malaysia","Maldives","Mali","Malta","Marshall Islands","Mauritania","Mauritius","Mexico","Micronesia","Moldova","Monaco","Mongolia","Montenegro","Morocco","Mozambique","Myanmar","Namibia","Nauru","Nepal","Netherlands","New Zealand","Nicaragua","Niger","Nigeria","North Macedonia","Norway","Oman","Pakistan","Palau","Palestine","Panama","Papua New Guinea","Paraguay","Peru","Philippines","Poland","Portugal","Qatar","Romania","Russia","Rwanda","Saint Kitts and Nevis","Saint Lucia","Saint Vincent and the Grenadines","Samoa","San Marino","Sao Tome and Principe","Saudi Arabia","Senegal","Serbia","Seychelles","Sierra Leone","Singapore","Slovakia","Slovenia","Solomon Islands","Somalia","South Africa","South Sudan","Spain","Sri Lanka","Sudan","Suriname","Sweden","Switzerland","Syria","Tajikistan","Tanzania","Thailand","Timor-Leste","Togo","Tonga","Trinidad and Tobago","Tunisia","Turkey","Turkmenistan","Tuvalu","Uganda","Ukraine","United Arab Emirates","United Kingdom","United States","Uruguay","Uzbekistan","Vanuatu","Vatican","Venezuela","Vietnam","Yemen","Zambia","Zimbabwe"]},"Locale":{"type":"string","enum":["ar","ar-AE","ar-BH","ar-DJ","ar-DZ","ar-EG","ar-EH","ar-ER","ar-IL","ar-IQ","ar-JO","ar-KM","ar-KW","ar-LB","ar-LY","ar-MA","ar-MR","ar-OM","ar-PS","ar-QA","ar-SA","ar-SD","ar-SO","ar-SS","ar-SY","ar-TD","ar-TN","ar-YE","as","as-IN","asa","asa-TZ","az","az-Cyrl","az-Cyrl-AZ","az-Latn","az-Latn-AZ","bas","bas-CM","be","be-BY","bem","bem-ZM","bez","bez-TZ","bg","bg-BG","bm","bm-ML","bn","bn-BD","bn-IN","bo","bo-CN","bo-IN","br","br-FR","brx","brx-IN","bs","bs-Cyrl","bs-Cyrl-BA","bs-Latn","bs-Latn-BA","ca","ca-AD","ca-ES","ca-FR","ca-IT","ce","ce-RU","cgg","cgg-UG","chr","chr-US","cs","cs-CZ","cy","cy-GB","da","da-DK","dav","dav-KE","de","de-AT","de-BE","de-CH","de-DE","de-IT","de-LI","de-LU","dje","dje-NE","dsb","dsb-DE","dua","dua-CM","dyo","dyo-SN","dz","dz-BT","ebu","ebu-KE","ee","ee-GH","ee-TG","el","el-CY","el-GR","en","en-AG","en-AI","en-AS","en-AT","en-AU","en-BB","en-BE","en-BI","en-BM","en-BS","en-BW","en-BZ","en-CA","en-CC","en-CH","en-CK","en-CM","en-CX","en-CY","en-DE","en-DG","en-DK","en-DM","en-ER","en-FI","en-FJ","en-FK","en-FM","en-GB","en-GD","en-GG","en-GH","en-GI","en-GM","en-GU","en-GY","en-HK","en-IE","en-IL","en-IM","en-IN","en-IO","en-JE","en-JM","en-KE","en-KI","en-KN","en-KY","en-LC","en-LR","en-LS","en-MG","en-MH","en-MO","en-MP","en-MS","en-MT","en-MU","en-MW","en-MY","ne-NP","en-NA","en-NF","en-NG","en-NL","en-NR","en-NU","en-NZ","en-PG","en-PH","en-PK","en-PN","en-PR","en-PW","en-RW","en-SB","en-SC","en-SD","en-SE","en-SG","en-SH","en-SI","en-SL","en-SS","en-SX","en-SZ","en-TC","en-TK","en-TO","en-TT","en-TV","en-TZ","en-UG","en-UM","en-US","en-VC","en-VG","en-VI","en-VU","en-WS","en-ZA","en-ZM","en-ZW","eo","es","es-AR","es-BO","es-BR","es-BZ","es-CL","es-CO","es-CR","es-CU","es-DO","es-EA","es-EC","es-ES","es-GQ","es-GT","es-HN","es-IC","es-MX","es-NI","es-PA","es-PE","es-PR","es-PY","es-SV","es-US","es-UY","es-VE","et","et-EE","eu","eu-ES","ewo","ewo-CM","fa","fa-AF","fa-IR","ff-CM","ps-AF","ff","ff-GN","ff-MR","ff-SN","fi","fi-FI","fil","fil-PH","fo","fo-DK","fo-FO","fr","fr-BE","fr-BF","fr-BI","fr-BJ","fr-BL","fr-CA","fr-CD","fr-CF","fr-CG","fr-CH","fr-CI","fr-CM","fr-DJ","fr-DZ","fr-FR","fr-GA","fr-GF","fr-GN","fr-GP","fr-GQ","fr-HT","fr-KM","fr-LU","fr-MA","fr-MC","fr-MF","fr-MG","fr-ML","fr-MQ","fr-MR","fr-MU","fr-NC","fr-NE","fr-PF","fr-PM","fr-RE","fr-RW","fr-SC","fr-SN","fr-SY","fr-TD","fr-TG","fr-TN","fr-VU","fr-WF","fr-YT","fur","fur-IT","fy","fy-NL","ga","ga-IE","gd","gd-GB","gl","gl-ES","gsw","gsw-CH","gsw-FR","gsw-LI","gu","gu-IN","guz","guz-KE","gv","gv-IM","ha","ha-GH","ha-NE","ha-NG","haw","haw-US","he","he-IL","hi","hi-IN","hr","hr-BA","hr-HR","hsb","hsb-DE","hu","hu-HU","hy","hy-AM","ig","ig-NG","ii","ii-CN","id","id-ID","is","is-IS","it","it-CH","it-IT","it-SM","it-VA","iw","iw-IL","ja","ja-JP","jgo","jgo-CM","jmc","jmc-TZ","ka","ka-GE","kab","kab-DZ","kam","kam-KE","kde","kde-TZ","kea","ml-IN","kea-CV","khq","khq-ML","ki","ki-KE","kk","kk-KZ","kkj","kkj-CM","kl","kl-GL","kln","kln-KE","km","km-KH","kn","kn-IN","ko","ko-KP","ko-KR","kok","kok-IN","ks","ks-IN","ksb","ksb-TZ","ksf","ksf-CM","ksh","ksh-DE","kw","kw-GB","ky","ky-KG","lag","lag-TZ","lt","lt-LT","lb","lb-LU","lv","lv-LV","lg","lg-UG","mk","mk-MK","ms","ms-MY","mt","mt-MT","nl","nl-BE","nl-NL","no","no-NO","no-NO-NY","pl","pl-PL","pt","pt-AO","pt-BR","pt-CH","pt-CV","pt-GQ","pt-GW","pt-LU","pt-MO","pt-MZ","pt-PT","pt-ST","pt-TL","ro","ro-RO","ru","ru-BY","ru-KG","ru-KZ","ru-MD","ru-RU","ru-UA","sk","sk-SK","sl","prs-AF","sl-SI","sq","sq-AL","sr","sr-BA","sr-CS","sr-ME","sq-ME","hr-ME","bs-ME","sr-RS","sv","sv-SE","ta","ta-ID","ta-IN","ta-MY","ta-MM","ta-MU","ta-PH","ta-SL","ta-SG","ta-TH","th","th-TH","th-TH-TH","tr","tr-TR","uk","uk-UA","vi","vi-VN","uz","uz-UZ","uz-AF","zh","zh-Hans","zh-Hans-HK","zh-Hans-MO","zh-Hans-SG","zh-Hant","zh-Hant-HK","zh-Hant-MO","zh-Hant-TW","zh-HK","zu","zu-ZA"]},"TimeZone":{"type":"string","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/La_Rioja","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Fort_Nelson","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Monticello","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montserrat","America/Nassau","America/New_York","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Ojinaga","America/Panama","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Whitehorse","America/Winnipeg","America/Yakutat","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Colombo","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Hebron","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Katmandu","Asia/Khandyga","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/Perth","Australia/Sydney","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Ulyanovsk","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis"]},"BackendApplicationType":{"type":"string","enum":["DAM","LLM"]},"StudioRole":{"type":"string","enum":["USER","ADMIN"]},"StudioSpaceRole":{"type":"string","enum":["VIEWER","CONTRIBUTOR","MANAGER","ADMIN"]},"SpaceUserCreate":{"type":"object","properties":{"spaceId":{"type":"string"},"spaceRole":{"allOf":[{"$ref":"#/components/schemas/StudioSpaceRole"}]},"isDefault":{"type":"boolean","description":"Whether this space is the user's default"}},"required":["spaceId","spaceRole"]},"UserStudioSettingsWithSpaces":{"type":"object","properties":{"role":{"allOf":[{"$ref":"#/components/schemas/StudioRole"}]},"defaultSpaceRole":{"allOf":[{"$ref":"#/components/schemas/StudioSpaceRole"}]},"spaces":{"type":"array","items":{"$ref":"#/components/schemas/SpaceUserCreate"}}},"required":["role"]},"AvaRole":{"type":"string","enum":["USER","MANAGER","ADMIN"]},"UserAvaSettings":{"type":"object","properties":{"role":{"allOf":[{"$ref":"#/components/schemas/AvaRole"}]}},"required":["role"]},"UserCreateRequest":{"type":"object","properties":{"emailAddress":{"type":"string","minLength":2,"maxLength":256,"description":"Email address must be unique."},"firstName":{"type":"string","minLength":2,"maxLength":256},"lastName":{"type":"string","minLength":2,"maxLength":256},"role":{"description":"The role of the user. Admins have access to the Aforza Admin Portal (https://admin.aforza.com)","allOf":[{"$ref":"#/components/schemas/UserRole"}]},"salesforceUserId":{"type":"string","minLength":18,"maxLength":18,"description":"The Salesforce user ID of the user. Must be 18 characters long."},"language":{"allOf":[{"$ref":"#/components/schemas/SupportedLanguage"}]},"country":{"allOf":[{"$ref":"#/components/schemas/Country"}]},"locale":{"allOf":[{"$ref":"#/components/schemas/Locale"}]},"timeZone":{"allOf":[{"$ref":"#/components/schemas/TimeZone"}]},"backendApplications":{"type":"array","minItems":0,"uniqueItems":true,"description":"A list of applications the user has access to. DAM = Aforza Studio, LLM = Ava","items":{"$ref":"#/components/schemas/BackendApplicationType"}},"studioSettings":{"example":{"role":"USER","defaultSpaceRole":"VIEWER"},"description":"Required if the user has access to Aforza Studio (backendApplications includes DAM)","allOf":[{"$ref":"#/components/schemas/UserStudioSettingsWithSpaces"}]},"avaSettings":{"example":{"role":"USER"},"description":"Required if the user has access to Ava (backendApplications includes LLM)","allOf":[{"$ref":"#/components/schemas/UserAvaSettings"}]}},"required":["emailAddress","firstName","lastName","role","backendApplications"]},"UserStatus":{"type":"string","enum":["PROVISIONED","ACTIVE","INACTIVE","DELETED"]},"UserBackendApplication":{"type":"object","properties":{"userId":{"type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/UserStatus"}]}},"required":["status"]},"UserBackendApplications":{"type":"object","properties":{"DAM":{"$ref":"#/components/schemas/UserBackendApplication"},"LLM":{"$ref":"#/components/schemas/UserBackendApplication"}}},"UserStudioSettings":{"type":"object","properties":{"role":{"allOf":[{"$ref":"#/components/schemas/StudioRole"}]}},"required":["role"]},"UserResponse":{"type":"object","properties":{"userId":{"type":"string","readOnly":true},"firstName":{"type":"string","readOnly":true},"lastName":{"type":"string","readOnly":true},"displayName":{"type":"string","readOnly":true},"emailAddress":{"type":"string","readOnly":true},"status":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserStatus"}]},"role":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserRole"}]},"createdDate":{"format":"date-time","type":"string","readOnly":true},"avatarUrl":{"type":"string","readOnly":true},"language":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/SupportedLanguage"}]},"country":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Country"}]},"locale":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Locale"}]},"timeZone":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/TimeZone"}]},"salesforceUserId":{"type":"string","readOnly":true},"oktaUserId":{"type":"string","readOnly":true},"backendApplications":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserBackendApplications"}]},"studioSettings":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserStudioSettings"}]},"avaSettings":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserAvaSettings"}]}},"required":["userId","firstName","lastName","displayName","emailAddress","status","role","createdDate","oktaUserId","backendApplications"]},"ErrorCode":{"type":"string","enum":["AVA_NOT_ENABLED","EMAIL_CONFLICT","NO_AVAILABLE_LICENCES","SALESFORCE_USER_ID_CONFLICT","STUDIO_NOT_ENABLED","STUDIO_SPACE_INFO_REQUIRED","THIRD_PARTY_EMAIL_CONFLICT","AVA_CONFIG_MISSING_REQUIRED_PROPERTIES","STUDIO_CONFIG_MISSING_REQUIRED_PROPERTIES","SSO_NOT_ENABLED","EXPIRED_CERT","INVALID_CERT"]},"Field":{"type":"string","enum":["displayName","emailAddress","firstName","lastName","oktaUserId","salesforceUserId","status","role","studioSettings","avaSettings","backendApplications","language","country","timeZone","locale","tenantId","tenantName","type","clientApplications","studioConfig","llmConfig","ssoEnabled","activeSsoId"]},"ErrorResponse":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"error":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"errorCode":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/ErrorCode"}]},"field":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/Field"}]}},"required":["statusCode","error","message"]},"UserField":{"type":"string","enum":["displayName","emailAddress","firstName","lastName","oktaUserId","salesforceUserId","status","role","studioSettings","avaSettings","backendApplications","language","country","timeZone","locale"]},"UserResponsePaged":{"type":"object","properties":{"count":{"type":"number","readOnly":true,"description":"The total number of users matching the query (not necessarily the number of users returned in `items`)."},"items":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/UserResponse"}}},"required":["count","items"]},"UserUpdateRequest":{"type":"object","properties":{"emailAddress":{"type":"string","minLength":2,"maxLength":256},"firstName":{"type":"string","minLength":2,"maxLength":256},"lastName":{"type":"string","minLength":2,"maxLength":256},"role":{"allOf":[{"$ref":"#/components/schemas/UserRole"}]},"salesforceUserId":{"type":"string","minLength":18,"maxLength":18,"nullable":true},"language":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/SupportedLanguage"}]},"country":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/Country"}]},"locale":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/Locale"}]},"timeZone":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/TimeZone"}]},"backendApplications":{"type":"array","minItems":1,"uniqueItems":true,"items":{"$ref":"#/components/schemas/BackendApplicationType"}},"studioSettings":{"example":{"role":"USER","defaultSpaceRole":"VIEWER"},"allOf":[{"$ref":"#/components/schemas/UserStudioSettingsWithSpaces"}]},"avaSettings":{"example":{"role":"USER"},"allOf":[{"$ref":"#/components/schemas/UserAvaSettings"}]}}}}}}