{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AccessScope":{"enum":["ALL","DIRECT","EFFECTIVE","INDIRECT"],"type":"string"},"AccessScopeFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/AccessScope"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"BadRequestExceptionResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"CountryCode":{"enum":["AE","AU","BE","BR","CA","CL","CO","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NG","NL","PL","SA","SE","SG","TR","US","ZA"],"type":"string"},"CountryCodesFilter":{"properties":{"include":{"items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"DeleteUserPermissionsError":{"properties":{"code":{"type":"string"},"countries":{"items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":100,"minItems":0,"type":"array"},"message":{"type":"string"},"userId":{"description":"User ID of the user that had an error when their permissions were deleted","type":"string"}},"type":"object"},"DeleteUserPermissionsRequestContent":{"properties":{"users":{"items":{"$ref":"#/components/schemas/UserId"},"maxItems":200,"minItems":1,"type":"array"}},"type":"object"},"DeleteUserPermissionsResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DeleteUserPermissionsError"},"type":"array"},"successes":{"items":{"$ref":"#/components/schemas/DeleteUserPermissionsSuccess"},"type":"array"}},"type":"object"},"DeleteUserPermissionsSuccess":{"properties":{"userId":{"description":"User ID of the user having their permissions deleted","type":"string"}},"type":"object"},"ForbiddenExceptionResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"ListUsersRequestContent":{"properties":{"accessScopeFilter":{"$ref":"#/components/schemas/AccessScopeFilter"},"countryCodesFilter":{"$ref":"#/components/schemas/CountryCodesFilter"},"maxResults":{"description":"Max results for pagination","maximum":100,"minimum":1,"type":"number"},"nextToken":{"description":"The pagination token that is required to go to the next page","type":"string"}},"type":"object"},"ListUsersResponseContent":{"properties":{"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"users":{"items":{"$ref":"#/components/schemas/User"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"NotFoundExceptionResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"Permission":{"properties":{"accessLevel":{"type":"string"},"countryCodes":{"items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":100,"minItems":0,"type":"array"},"id":{"type":"string"},"resourceType":{"type":"string"}},"type":"object"},"PermissionId":{"properties":{"name":{"type":"string"}},"type":"object"},"PermissionSet":{"properties":{"customPermissionSet":{"description":"If type \u003d CUSTOM_PERMISSION_SET, indicates the permissions of the invitation.\nDifferent permissions are supported for different account types.\n  - Amazon DSP Advertising Accounts: campaign_edit, creatives_edit, reports_edit, reports_limited\n  - Sponsored Ads Accounts: campaign_edit, campaign_view, reports_view, brand_posts_edit, store_edit,\n  payment_method_edit, payment_method_view billing_edit, billing_view, user_edit\n  - Manager accounts do not support custom permissions\n  - Marketing Cloud Accounts do not support custom permissions","items":{"$ref":"#/components/schemas/PermissionId"},"maxItems":200,"minItems":1,"type":"array"},"role":{"$ref":"#/components/schemas/Role"},"type":{"$ref":"#/components/schemas/Type"}},"required":["type"],"type":"object"},"QueryUserPermissionsRequestContent":{"properties":{"accessScopeFilter":{"$ref":"#/components/schemas/AccessScopeFilter"},"countryCodesFilter":{"$ref":"#/components/schemas/CountryCodesFilter"},"maxResults":{"description":"Max results for pagination","maximum":100,"minimum":1,"type":"number"},"nextToken":{"description":"The pagination token that is required to go to the next page","type":"string"},"userId":{"description":"User ID for the request","maxLength":150,"pattern":"\\S*","type":"string"}},"required":["userId"],"type":"object"},"QueryUserPermissionsResponseContent":{"properties":{"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"permissions":{"items":{"$ref":"#/components/schemas/Permission"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"QueryUserRolesRequestContent":{"properties":{"countryCodesFilter":{"$ref":"#/components/schemas/CountryCodesFilter"},"maxResults":{"description":"Max results for pagination","maximum":100,"minimum":1,"type":"number"},"nextToken":{"description":"The pagination token that is required to go to the next page","type":"string"},"userId":{"description":"This represents the userId of the target of the QueryUserRoles call","maxLength":150,"pattern":"\\S*","type":"string"}},"required":["userId"],"type":"object"},"QueryUserRolesResponseContent":{"properties":{"nextToken":{"description":"token value allowing to navigate to the next response page","type":"string"},"roles":{"items":{"$ref":"#/components/schemas/RoleForCountries"},"maxItems":5,"minItems":0,"type":"array"}},"type":"object"},"RateLimitExceededExceptionResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"Role":{"enum":["ADMIN","EDITOR","VIEWER"],"type":"string"},"RoleForCountries":{"properties":{"countryCodes":{"description":"The roles for an account are associated to a specific country/countries\nThese roles may differ per countries","items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":100,"minItems":0,"type":"array"},"permissions":{"description":"List of granular permission strings populated when type is CUSTOM_PERMISSION_SET\nand accessType is EXTERNAL.","items":{"type":"string"},"maxItems":200,"minItems":0,"type":"array"},"role":{"$ref":"#/components/schemas/Role"},"type":{"$ref":"#/components/schemas/Type"}},"type":"object"},"ServiceExceptionResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"Type":{"enum":["CUSTOM_PERMISSION_SET","ROLE"],"type":"string"},"UnauthorizedExceptionResponseContent":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"UpdateUserPermissionsError":{"properties":{"code":{"type":"string"},"message":{"type":"string"},"userId":{"description":"User ID of the user having their permissions updated","type":"string"}},"type":"object"},"UpdateUserPermissionsRequestContent":{"properties":{"userPermissions":{"items":{"$ref":"#/components/schemas/UserPermission"},"type":"array"}},"type":"object"},"UpdateUserPermissionsResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/UpdateUserPermissionsError"},"type":"array"},"successes":{"items":{"$ref":"#/components/schemas/UpdateUserPermissionsSuccess"},"type":"array"}},"type":"object"},"UpdateUserPermissionsSuccess":{"properties":{"userId":{"description":"User ID of the user having their permissions updated","type":"string"}},"type":"object"},"User":{"properties":{"countryCodes":{"items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":100,"minItems":0,"type":"array"},"emailAddress":{"type":"string"},"userId":{"type":"string"}},"required":["emailAddress","userId"],"type":"object"},"UserCannotBeRemovedExceptionResponseContent":{"properties":{"code":{"type":"string"},"countries":{"items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":100,"minItems":0,"type":"array"},"message":{"type":"string"}},"type":"object"},"UserId":{"properties":{"userId":{"type":"string"}},"type":"object"},"UserPermission":{"properties":{"countryCodes":{"description":"List of two-letter ISO 3166 country codes that the user is having permissions edited for. Only valid for updates\nto global accounts.","items":{"$ref":"#/components/schemas/CountryCode"},"maxItems":100,"minItems":0,"type":"array"},"permissionSet":{"$ref":"#/components/schemas/PermissionSet"},"userId":{"description":"User ID of the user having their permissions updated","type":"string"}},"type":"object"}},"securitySchemes":{}},"info":{"description":"Authorization and Permission management for your Amazon Ads Accounts","title":"Advertising User Permissions Management","version":"3.0"},"openapi":"3.0.1","paths":{"/userPermissions":{"put":{"description":"\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"account_edit\",\"manage_users\",\"user_edit\"]\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"manage_users\",\"user_edit\"]\n\n**Authorized resource type**:\nGlobal Manager Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-ManagerAccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\"]\n\n**Authorized resource type**:\nAMC Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"AMC_ADMIN\"]","operationId":"UpdateUserPermissions","parameters":[{"description":"The Global Account Identifiers and DSP Identifiers are passed using this header. Use `GET` method /globaladsaccounts and /dsp/advertisers to get the account ids that you have access to.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The Global Account Identifiers and DSP Identifiers are passed using this header. Use `GET` method /globaladsaccounts and /dsp/advertisers to get the account ids that you have access to.","maxLength":150,"pattern":"\\S*","type":"string"}},{"description":"The Manager Account Identifiers are passed using this header. Use `GET` method /manageraccounts to get the account ids that you have access to.","in":"header","name":"Amazon-Ads-ManagerAccountId","schema":{"description":"The Manager Account Identifiers are passed using this header. Use `GET` method /manageraccounts to get the account ids that you have access to.","maxLength":150,"pattern":"\\S*","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","maxLength":150,"pattern":"\\S*","type":"string"}},{"description":"The Profile Identifiers are passed using this header. Use `GET` method /profiles to get the account ids that you have access to.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The Profile Identifiers are passed using this header. Use `GET` method /profiles to get the account ids that you have access to.","maxLength":150,"pattern":"\\S*","type":"string"}}],"requestBody":{"content":{"application/vnd.MinosAuthorizationNativeServicePublicAPI.UpdateUserPermissionsResource.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.MinosAuthorizationNativeServicePublicAPI.UpdateUserPermissionsResource.v1+json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsResponseContent"}}},"description":"UpdateUserPermissions 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenExceptionResponseContent"}}},"description":"ForbiddenException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundExceptionResponseContent"}}},"description":"NotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededExceptionResponseContent"}}},"description":"RateLimitExceededException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceExceptionResponseContent"}}},"description":"ServiceException 500 response"}},"tags":["Update User Permissions"]}},"/userPermissions/delete":{"post":{"description":"\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"account_edit\",\"manage_users\",\"user_edit\"]\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"manage_users\",\"user_edit\"]\n\n**Authorized resource type**:\nGlobal Manager Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-ManagerAccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\"]\n\n**Authorized resource type**:\nAMC Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"AMC_ADMIN\"]","operationId":"DeleteUserPermissions","parameters":[{"description":"The Global Account Identifiers and DSP Identifiers are passed using this header. Use `GET` method /globaladsaccounts and /dsp/advertisers to get the account ids that you have access to.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The Global Account Identifiers and DSP Identifiers are passed using this header. Use `GET` method /globaladsaccounts and /dsp/advertisers to get the account ids that you have access to.","maxLength":150,"pattern":"\\S*","type":"string"}},{"description":"The Manager Account Identifiers are passed using this header. Use `GET` method /manageraccounts to get the account ids that you have access to.","in":"header","name":"Amazon-Ads-ManagerAccountId","schema":{"description":"The Manager Account Identifiers are passed using this header. Use `GET` method /manageraccounts to get the account ids that you have access to.","maxLength":150,"pattern":"\\S*","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","maxLength":150,"pattern":"\\S*","type":"string"}},{"description":"The Profile Identifiers are passed using this header. Use `GET` method /profiles to get the account ids that you have access to.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The Profile Identifiers are passed using this header. Use `GET` method /profiles to get the account ids that you have access to.","maxLength":150,"pattern":"\\S*","type":"string"}}],"requestBody":{"content":{"application/vnd.MinosAuthorizationNativeServicePublicAPI.DeleteUserPermissionsResource.v1+json":{"schema":{"$ref":"#/components/schemas/DeleteUserPermissionsRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.MinosAuthorizationNativeServicePublicAPI.DeleteUserPermissionsResource.v1+json":{"schema":{"$ref":"#/components/schemas/DeleteUserPermissionsResponseContent"}}},"description":"DeleteUserPermissions 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCannotBeRemovedExceptionResponseContent"}}},"description":"UserCannotBeRemovedException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenExceptionResponseContent"}}},"description":"ForbiddenException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundExceptionResponseContent"}}},"description":"NotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededExceptionResponseContent"}}},"description":"RateLimitExceededException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceExceptionResponseContent"}}},"description":"ServiceException 500 response"}},"tags":["Delete User Permissions"]}},"/userPermissions/list":{"post":{"description":"\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"account_view\",\"account_edit\",\"manage_users\",\"user_edit\",\"campaign_view\",\"campaign_edit\",\"advertiser_campaign_view\",\"advertiser_campaign_edit\",\"sa_campaign_view\",\"dsp_campaign_view\",\"sa_campaign_edit\",\"dsp_campaign_edit\"]\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"manage_users\",\"user_edit\",\"campaign_view\",\"campaign_edit\",\"advertiser_campaign_view\",\"advertiser_campaign_edit\",\"sa_campaign_view\",\"dsp_campaign_view\",\"sa_campaign_edit\",\"dsp_campaign_edit\"]\n\n**Authorized resource type**:\nGlobal Manager Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-ManagerAccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"user-view\"]\n\n**Authorized resource type**:\nAMC Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"AMC_ADMIN\"]","operationId":"QueryUserPermissions","parameters":[{"description":"The Global Account Identifiers and DSP Identifiers are passed using this header. Use `GET` method /globaladsaccounts and /dsp/advertisers to get the account ids that you have access to.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The Global Account Identifiers and DSP Identifiers are passed using this header. Use `GET` method /globaladsaccounts and /dsp/advertisers to get the account ids that you have access to.","maxLength":150,"pattern":"\\S*","type":"string"}},{"description":"The Manager Account Identifiers are passed using this header. Use `GET` method /manageraccounts to get the account ids that you have access to.","in":"header","name":"Amazon-Ads-ManagerAccountId","schema":{"description":"The Manager Account Identifiers are passed using this header. Use `GET` method /manageraccounts to get the account ids that you have access to.","maxLength":150,"pattern":"\\S*","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","examples":{"QueryUserPermissions_example1":{"summary":"Global request with countryCodeFilter only","value":"amzn1.application-oa2-client.647610038d6d4f3d868b6207ec6ef9ca"},"QueryUserPermissions_example2":{"summary":"Marketplace request with no filters.","value":"amzn1.application-oa2-client.647610038d6d4f3d868b6207ec6ef9ca"}},"in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","maxLength":150,"pattern":"\\S*","type":"string"}},{"description":"The Profile Identifiers are passed using this header. Use `GET` method /profiles to get the account ids that you have access to.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The Profile Identifiers are passed using this header. Use `GET` method /profiles to get the account ids that you have access to.","maxLength":150,"pattern":"\\S*","type":"string"}}],"requestBody":{"content":{"application/vnd.queryuserpermissions.v1+json":{"schema":{"$ref":"#/components/schemas/QueryUserPermissionsRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.queryuserpermissions.v1+json":{"schema":{"$ref":"#/components/schemas/QueryUserPermissionsResponseContent"}}},"description":"QueryUserPermissions 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenExceptionResponseContent"}}},"description":"ForbiddenException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundExceptionResponseContent"}}},"description":"NotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededExceptionResponseContent"}}},"description":"RateLimitExceededException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceExceptionResponseContent"}}},"description":"ServiceException 500 response"}},"tags":["Query User Permissions"]}},"/userRoles/list":{"post":{"description":"\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"account_view\",\"account_edit\",\"manage_users\",\"user_edit\"]\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"manage_users\",\"user_edit\"]\n\n**Authorized resource type**:\nGlobal Manager Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-ManagerAccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"user-view\"]\n\n**Authorized resource type**:\nAMC Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"AMC_ADMIN\"]","operationId":"QueryUserRoles","parameters":[{"description":"The Global Account Identifiers and DSP Identifiers are passed using this header. Use `GET` method /globaladsaccounts and /dsp/advertisers to get the account ids that you have access to.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The Global Account Identifiers and DSP Identifiers are passed using this header. Use `GET` method /globaladsaccounts and /dsp/advertisers to get the account ids that you have access to.","maxLength":150,"pattern":"\\S*","type":"string"}},{"description":"The Manager Account Identifiers are passed using this header. Use `GET` method /manageraccounts to get the account ids that you have access to.","in":"header","name":"Amazon-Ads-ManagerAccountId","schema":{"description":"The Manager Account Identifiers are passed using this header. Use `GET` method /manageraccounts to get the account ids that you have access to.","maxLength":150,"pattern":"\\S*","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","examples":{"QueryUserRoles_example1":{"summary":"Non global request with userIdFilter only and a standardized role","value":"amzn1.application-oa2-client.647610038d6d4f3d868b6207ec6ef9ca"},"QueryUserRoles_example2":{"summary":"Non global request with userIdFilter only and custom role","value":"amzn1.application-oa2-client.647610038d6d4f3d868b6207ec6ef9ca"},"QueryUserRoles_example3":{"summary":"Global request with userIdFilter only and custom role","value":"amzn1.application-oa2-client.647610038d6d4f3d868b6207ec6ef9ca"}},"in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","maxLength":150,"pattern":"\\S*","type":"string"}},{"description":"The Profile Identifiers are passed using this header. Use `GET` method /profiles to get the account ids that you have access to.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The Profile Identifiers are passed using this header. Use `GET` method /profiles to get the account ids that you have access to.","maxLength":150,"pattern":"\\S*","type":"string"}}],"requestBody":{"content":{"application/vnd.queryuserroles.v1+json":{"schema":{"$ref":"#/components/schemas/QueryUserRolesRequestContent"}}},"required":true},"responses":{"200":{"content":{"application/vnd.queryuserroles.v1+json":{"schema":{"$ref":"#/components/schemas/QueryUserRolesResponseContent"}}},"description":"QueryUserRoles 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenExceptionResponseContent"}}},"description":"ForbiddenException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundExceptionResponseContent"}}},"description":"NotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededExceptionResponseContent"}}},"description":"RateLimitExceededException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceExceptionResponseContent"}}},"description":"ServiceException 500 response"}},"tags":["Query User Roles"]}},"/users/list":{"post":{"description":"\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"account_view\",\"account_edit\",\"manage_users\",\"user_edit\"]\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"manage_users\",\"user_edit\"]\n\n**Authorized resource type**:\nGlobal Manager Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-ManagerAccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"MasterAccount_Manager\",\"MasterAccount_Viewer\",\"MA_ReadOnly\",\"user-view\"]\n\n**Authorized resource type**:\nAMC Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"AMC_ADMIN\"]","operationId":"ListUsers","parameters":[{"description":"The Global Account Identifiers and DSP Identifiers are passed using this header. Use `GET` method /globaladsaccounts and /dsp/advertisers to get the account ids that you have access to.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"The Global Account Identifiers and DSP Identifiers are passed using this header. Use `GET` method /globaladsaccounts and /dsp/advertisers to get the account ids that you have access to.","maxLength":150,"pattern":"\\S*","type":"string"}},{"description":"The Manager Account Identifiers are passed using this header. Use `GET` method /manageraccounts to get the account ids that you have access to.","in":"header","name":"Amazon-Ads-ManagerAccountId","schema":{"description":"The Manager Account Identifiers are passed using this header. Use `GET` method /manageraccounts to get the account ids that you have access to.","maxLength":150,"pattern":"\\S*","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","examples":{"ListUsers_example1":{"summary":"Request with a filter.","value":"amzn1.application-oa2-client.647610038d6d4f3d868b6207ec6ef9ca"},"ListUsers_example2":{"summary":"Request with new filter.","value":"amzn1.application-oa2-client.647610038d6d4f3d868b6207ec6ef9ca"}},"in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","maxLength":150,"pattern":"\\S*","type":"string"}},{"description":"The Profile Identifiers are passed using this header. Use `GET` method /profiles to get the account ids that you have access to.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"description":"The Profile Identifiers are passed using this header. Use `GET` method /profiles to get the account ids that you have access to.","maxLength":150,"pattern":"\\S*","type":"string"}}],"requestBody":{"content":{"application/vnd.listusers.v1+json":{"schema":{"$ref":"#/components/schemas/ListUsersRequestContent"}}}},"responses":{"200":{"content":{"application/vnd.listusers.v1+json":{"schema":{"$ref":"#/components/schemas/ListUsersResponseContent"}}},"description":"ListUsers 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestExceptionResponseContent"}}},"description":"BadRequestException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenExceptionResponseContent"}}},"description":"ForbiddenException 403 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundExceptionResponseContent"}}},"description":"NotFoundException 404 response"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitExceededExceptionResponseContent"}}},"description":"RateLimitExceededException 429 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceExceptionResponseContent"}}},"description":"ServiceException 500 response"}},"tags":["List Users"]}}}}