{"openapi":"3.0.2","info":{"title":"Uplifter API","description":"Use this api to interact with account data stored in uplifter.  For documentation on authentication, visit: www.support.uplifter.ai or contact: support@uplifter.ai","version":"0.1.0"},"paths":{"/account":{"get":{"tags":["Account"],"summary":"Listaccounts","description":"Returns a list of accounts that the key has access to\n    ","operationId":"listAccounts_account_get","parameters":[{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"},{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountList"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/track/campaign-codes":{"get":{"tags":["Track"],"summary":"Campaigncodes","description":"Request campaign codes for a given account\n    ","operationId":"campaignCodes_track_campaign_codes_get","parameters":[{"required":false,"schema":{"title":"Response Mode","type":"string","default":"csv"},"name":"response_mode","in":"query"},{"required":true,"schema":{"title":"Account Id","type":"string"},"name":"account_id","in":"query"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"},{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"}],"responses":{"200":{"description":"A csv file containing campaign codes, email addresses and definitions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Success"}},"text/csv":{}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/track/campaign-code-stats":{"get":{"tags":["Track"],"summary":"Campaigncodesstats","description":"Request campaign codes for a given account\n    ","operationId":"campaignCodesStats_track_campaign_code_stats_get","parameters":[{"required":false,"schema":{"title":"Response Mode","type":"string","default":"csv"},"name":"response_mode","in":"query"},{"required":true,"schema":{"title":"Account Id","type":"string"},"name":"account_id","in":"query"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"},{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"}],"responses":{"200":{"description":"A csv file of each campaign link and each metric for that link","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Success"}},"text/csv":{}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/report/list-saved-other-link-reports":{"get":{"tags":["Report"],"summary":"Listaccounts","description":"Returns a list of accounts that the key has access to\n    ","operationId":"listAccounts_report_list_saved_other_link_reports_get","parameters":[{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"},{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportList"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/report/download-other-link-report/{report_id}":{"get":{"tags":["Report"],"summary":"Other Link Report Download","description":"Downloads the other link report as a csv file, useful for email platforms that automatically\nadd utm parameters to links, this report will show the performance of each link","operationId":"other_link_report_download_report_download_other_link_report__report_id__get","parameters":[{"required":true,"schema":{"title":"Report Id","type":"string"},"name":"report_id","in":"path"},{"description":"Split the report by date","required":false,"schema":{"title":"Split By Date","type":"boolean","description":"Split the report by date","default":false},"name":"split_by_date","in":"query"},{"required":true,"schema":{"title":"Account Id","type":"string"},"name":"account_id","in":"query"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"},{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"}],"responses":{"200":{"description":"A csv file of each campaign link and each metric for that link","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Success"}},"text/csv":{}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scim/v2/Users":{"get":{"tags":["SCIM_v2"],"summary":"Get Users","description":"Return all users that are associated with the company\n    ","operationId":"get_users_scim_v2_Users_get","parameters":[{"required":false,"schema":{"title":"Attributes","type":"string"},"name":"attributes","in":"query"},{"required":false,"schema":{"title":"Excludedattributes","type":"string"},"name":"excludedAttributes","in":"query"},{"required":false,"schema":{"title":"Startindex","type":"integer","default":1},"name":"startIndex","in":"query"},{"required":false,"schema":{"title":"Count","type":"integer"},"name":"count","in":"query"},{"required":false,"schema":{"title":"Sortby","type":"string"},"name":"sortBy","in":"query"},{"required":false,"schema":{"title":"Sortorder","type":"string","default":"ascending"},"name":"sortOrder","in":"query"},{"required":false,"schema":{"title":"Filter","type":"string"},"name":"filter","in":"query"},{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Users Scim V2 Users Get","anyOf":[{"$ref":"#/components/schemas/ListResponse_User_"},{"$ref":"#/components/schemas/ScimError"}]}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["SCIM_v2"],"summary":"Create User","description":"Creates a new user.\nThe external ID should be the unique ID of the user from the identity provider to enable SSO.  For microsoft, this will be the user's object ID.\nThe userName is an email and must match the primary email of the user.","operationId":"create_user_scim_v2_Users_post","parameters":[{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Create User Scim V2 Users Post","anyOf":[{"$ref":"#/components/schemas/User"},{"$ref":"#/components/schemas/ScimError"}]}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scim/v2/Users/{user_id}":{"get":{"tags":["SCIM_v2"],"summary":"Get User","description":"Returns a single account that the key has access to\n    ","operationId":"get_user_scim_v2_Users__user_id__get","parameters":[{"required":true,"schema":{"title":"User Id","type":"string"},"name":"user_id","in":"path"},{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get User Scim V2 Users  User Id  Get","anyOf":[{"$ref":"#/components/schemas/User"},{"$ref":"#/components/schemas/ScimError"}]}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["SCIM_v2"],"summary":"Update User","description":"Updates a user by replacing the entire user object.  for updating a single field, prefer PATCH\n    ","operationId":"update_user_scim_v2_Users__user_id__put","parameters":[{"required":true,"schema":{"title":"User Id","type":"string"},"name":"user_id","in":"path"},{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["SCIM_v2"],"summary":"Delete User","description":"Removes the user from the list of users managed by SCIM and prevents them\nfrom accessing the application.  The email address is retained so that the\naudit process for links is maintained.","operationId":"delete_user_scim_v2_Users__user_id__delete","parameters":[{"required":true,"schema":{"title":"User Id","type":"string"},"name":"user_id","in":"path"},{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimError"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["SCIM_v2"],"summary":"Patch User","description":"Update a scim field on the user - active, displayName, or userName\nAn updated userName must match the primary email of the user.","operationId":"patch_user_scim_v2_Users__user_id__patch","parameters":[{"required":true,"schema":{"title":"User Id","type":"string"},"name":"user_id","in":"path"},{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPatchOp"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scim/v2/Groups":{"get":{"tags":["SCIM_v2"],"summary":"Get Groups","description":"Returns a list of groups (workspaces) with associated entitlements ","operationId":"get_groups_scim_v2_Groups_get","parameters":[{"required":false,"schema":{"title":"Filter","type":"string"},"name":"filter","in":"query"},{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Groups Scim V2 Groups Get","anyOf":[{"$ref":"#/components/schemas/ListResponse_Group_"},{"$ref":"#/components/schemas/ScimError"}]}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["SCIM_v2"],"summary":"Create Group","description":"Creates a new group\n    ","operationId":"create_group_scim_v2_Groups_post","parameters":[{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Create Group Scim V2 Groups Post","anyOf":[{"$ref":"#/components/schemas/Group"},{"$ref":"#/components/schemas/ScimError"}]}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scim/v2/Groups/{groupID}":{"get":{"tags":["SCIM_v2"],"summary":"Get Group","description":"Returns a single group that the key has access to\n    ","operationId":"get_group_scim_v2_Groups__groupID__get","parameters":[{"required":true,"schema":{"title":"Groupid","type":"string"},"name":"groupID","in":"path"},{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Group Scim V2 Groups  Groupid  Get","anyOf":[{"$ref":"#/components/schemas/Group"},{"$ref":"#/components/schemas/ScimError"}]}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scim/v2/Groups/{group_id}":{"put":{"tags":["SCIM_v2"],"summary":"Put Groups","description":"Replaces a group with a new group.  use to add or remove users from the group.\n    ","operationId":"put_groups_scim_v2_Groups__group_id__put","parameters":[{"required":true,"schema":{"title":"Group Id","type":"string"},"name":"group_id","in":"path"},{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimError"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["SCIM_v2"],"summary":"Delete Group","description":"Deletes a group\n    ","operationId":"delete_group_scim_v2_Groups__group_id__delete","parameters":[{"required":true,"schema":{"title":"Group Id","type":"string"},"name":"group_id","in":"path"},{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimError"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["SCIM_v2"],"summary":"Patch Group","description":"Patches a group.  use to add or remove users from the group.\n    ","operationId":"patch_group_scim_v2_Groups__group_id__patch","parameters":[{"required":true,"schema":{"title":"Group Id","type":"string"},"name":"group_id","in":"path"},{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupPatchOp"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Patch Group Scim V2 Groups  Group Id  Patch","anyOf":[{"$ref":"#/components/schemas/Group"},{"$ref":"#/components/schemas/ScimError"}]}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scim/v2/Entitlements":{"get":{"tags":["SCIM_v2"],"summary":"Get Entitlements","operationId":"get_entitlements_scim_v2_Entitlements_get","parameters":[{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Entitlements Scim V2 Entitlements Get","anyOf":[{"$ref":"#/components/schemas/ListResponse_Entitlement_"},{"$ref":"#/components/schemas/ScimError"}]}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scim/v2/Entitlements/{entitlement_id}":{"get":{"tags":["SCIM_v2"],"summary":"Get Entitlement","description":"Returns a single entitlement that the key has access to\n    ","operationId":"get_entitlement_scim_v2_Entitlements__entitlement_id__get","parameters":[{"required":true,"schema":{"title":"Entitlement Id","type":"string"},"name":"entitlement_id","in":"path"},{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Entitlement Scim V2 Entitlements  Entitlement Id  Get","anyOf":[{"$ref":"#/components/schemas/Entitlement"},{"$ref":"#/components/schemas/ScimError"}]}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scim/v2/Roles":{"get":{"tags":["SCIM_v2"],"summary":"Get Roles","operationId":"get_roles_scim_v2_Roles_get","parameters":[{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Roles Scim V2 Roles Get","anyOf":[{"$ref":"#/components/schemas/ListResponse_Role_"},{"$ref":"#/components/schemas/ScimError"}]}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scim/v2/Roles/{role_id}":{"get":{"tags":["SCIM_v2"],"summary":"Get Role","description":"Returns a single role that the key has access to\n    ","operationId":"get_role_scim_v2_Roles__role_id__get","parameters":[{"required":true,"schema":{"title":"Role Id","type":"string"},"name":"role_id","in":"path"},{"required":false,"schema":{"title":"Authorization","type":"string"},"name":"Authorization","in":"header"},{"required":false,"schema":{"title":"X-Api-Key","type":"string"},"name":"x-api-key","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Role Scim V2 Roles  Role Id  Get","anyOf":[{"$ref":"#/components/schemas/Role"},{"$ref":"#/components/schemas/ScimError"}]}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scim/v2/Schemas":{"get":{"tags":["SCIM_v2"],"summary":"Get Schemas","description":"Returns a list of schemas that the key has access to.","operationId":"get_schemas_scim_v2_Schemas_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Schemas Scim V2 Schemas Get","anyOf":[{"$ref":"#/components/schemas/ListResponse_Schema_"},{"$ref":"#/components/schemas/ScimError"}]}}}},"404":{"description":"Not found"}}}},"/scim/v2/Schemas/{schema_type}":{"get":{"tags":["SCIM_v2"],"summary":"Get Schema","description":"Returns a single schema that the key has access to\n    ","operationId":"get_schema_scim_v2_Schemas__schema_type__get","parameters":[{"required":true,"schema":{"title":"Schema Type","type":"string"},"name":"schema_type","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Schema Scim V2 Schemas  Schema Type  Get","anyOf":[{"$ref":"#/components/schemas/Schema"},{"$ref":"#/components/schemas/ScimError"}]}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/scim/v2/ServiceProviderConfig":{"get":{"tags":["SCIM_v2"],"summary":"Get Service Provider Config","description":"Returns the service provider configuration\n    ","operationId":"get_service_provider_config_scim_v2_ServiceProviderConfig_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceProviderConfig"}}}},"404":{"description":"Not found"}}}},"/scim/v2/ResourceTypes":{"get":{"tags":["SCIM_v2"],"summary":"Get Resource Types","description":"Returns a list of resource types that the key has access to.","operationId":"get_resource_types_scim_v2_ResourceTypes_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Resource Types Scim V2 Resourcetypes Get","anyOf":[{"$ref":"#/components/schemas/ListResponse_ScimResourceType_"},{"$ref":"#/components/schemas/ScimError"}]}}}},"404":{"description":"Not found"}}}},"/scim/v2/ResourceTypes/{resType}":{"get":{"tags":["SCIM_v2"],"summary":"Get Resource Type","operationId":"get_resource_type_scim_v2_ResourceTypes__resType__get","parameters":[{"required":true,"schema":{"title":"Restype","type":"string"},"name":"resType","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Resource Type Scim V2 Resourcetypes  Restype  Get","anyOf":[{"$ref":"#/components/schemas/ScimResourceType"},{"$ref":"#/components/schemas/ScimError"}]}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Account":{"title":"Account","required":["accountName","accountID"],"type":"object","properties":{"accountName":{"title":"Accountname","type":"string"},"accountID":{"title":"Accountid","type":"string"}}},"AccountList":{"title":"AccountList","required":["accountList"],"type":"object","properties":{"accountList":{"title":"Accountlist","type":"array","items":{"$ref":"#/components/schemas/Account"}}}},"Entitlement":{"title":"Entitlement","type":"object","properties":{"id":{"title":"Id","type":"string","description":"workspaceID;permissionID"},"displayName":{"title":"Displayname","type":"string","description":"Workspace: permission (eg. 'Uplifter.ai: Admin')"},"$ref":{"title":"$Ref","type":"string","description":"The URI corresponding to a SCIM resource that is a member of this Group."},"type":{"title":"Type","type":"string","description":"The type of the entitlement."},"resourceType":{"title":"Resourcetype","type":"string","description":"The type of the resource. Should be Entitlement."},"primary":{"title":"Primary","type":"boolean","description":"A Boolean value indicating if this is the primary entitlement."},"meta":{"title":"Meta","allOf":[{"$ref":"#/components/schemas/ScimMeta"}],"description":"The metadata of the entitlement."},"members":{"title":"Members","type":"array","items":{"$ref":"#/components/schemas/GenericMember"},"description":"The members of the entitlement."}}},"GenericMember":{"title":"GenericMember","required":["value"],"type":"object","properties":{"value":{"title":"Value","type":"string","description":"The identifier of the member of this Entitlement."},"type":{"title":"Type","type":"string","description":"The type of the member of this Entitlement."},"display":{"title":"Display","type":"string","description":"The display name of the member of this Entitlement."}}},"Group":{"title":"Group","type":"object","properties":{"id":{"title":"Id","type":"string","description":"The unique identifier for a group."},"displayName":{"title":"Displayname","type":"string","description":"The display name of the group."},"members":{"title":"Members","type":"array","items":{"$ref":"#/components/schemas/GroupMember"},"description":"The members of the group."},"schemas":{"title":"Schemas","type":"array","items":{"enum":["urn:ietf:params:scim:schemas:core:2.0:Group"],"type":"string"},"description":"should be urn:ietf:params:scim:schemas:core:2.0:Group"},"meta":{"title":"Meta","allOf":[{"$ref":"#/components/schemas/ScimMeta"}],"description":"The metadata of the group."}}},"GroupMember":{"title":"GroupMember","required":["value"],"type":"object","properties":{"value":{"title":"Value","type":"string","description":"The identifier of the member of this Group."},"display":{"title":"Display","type":"string","description":"The display name of the member of this Group."},"$ref":{"title":"$Ref","type":"string","description":"The URI corresponding to a SCIM resource that is a member of this Group."}}},"GroupPatchOp":{"title":"GroupPatchOp","type":"object","properties":{"schemas":{"title":"Schemas","type":"array","items":{"type":"string"},"description":"should be urn:ietf:params:scim:api:messages:2.0:PatchOp"},"Operations":{"title":"Operations","type":"array","items":{"$ref":"#/components/schemas/MemberOp"},"description":"The operations to perform."}}},"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ListResponse_Entitlement_":{"title":"ListResponse[Entitlement]","required":["totalResults","itemsPerPage","startIndex","schemas","Resources"],"type":"object","properties":{"totalResults":{"title":"Totalresults","type":"integer","description":"The total number of results returned by the list or query operation."},"itemsPerPage":{"title":"Itemsperpage","type":"integer","description":"The number of resources returned in a list response page."},"startIndex":{"title":"Startindex","type":"integer","description":"The 1-based index of the first result in the current set of list results."},"schemas":{"title":"Schemas","type":"array","items":{"type":"string"},"description":"should be urn:ietf:params:scim:api:messages:2.0:ListResponse"},"Resources":{"title":"Resources","allOf":[{"$ref":"#/components/schemas/Entitlement"}],"description":"The list of resources returned by the list or query operation.","union_mode":"left_to_right"}}},"ListResponse_Group_":{"title":"ListResponse[Group]","required":["totalResults","itemsPerPage","startIndex","schemas","Resources"],"type":"object","properties":{"totalResults":{"title":"Totalresults","type":"integer","description":"The total number of results returned by the list or query operation."},"itemsPerPage":{"title":"Itemsperpage","type":"integer","description":"The number of resources returned in a list response page."},"startIndex":{"title":"Startindex","type":"integer","description":"The 1-based index of the first result in the current set of list results."},"schemas":{"title":"Schemas","type":"array","items":{"type":"string"},"description":"should be urn:ietf:params:scim:api:messages:2.0:ListResponse"},"Resources":{"title":"Resources","allOf":[{"$ref":"#/components/schemas/Group"}],"description":"The list of resources returned by the list or query operation.","union_mode":"left_to_right"}}},"ListResponse_Role_":{"title":"ListResponse[Role]","required":["totalResults","itemsPerPage","startIndex","schemas","Resources"],"type":"object","properties":{"totalResults":{"title":"Totalresults","type":"integer","description":"The total number of results returned by the list or query operation."},"itemsPerPage":{"title":"Itemsperpage","type":"integer","description":"The number of resources returned in a list response page."},"startIndex":{"title":"Startindex","type":"integer","description":"The 1-based index of the first result in the current set of list results."},"schemas":{"title":"Schemas","type":"array","items":{"type":"string"},"description":"should be urn:ietf:params:scim:api:messages:2.0:ListResponse"},"Resources":{"title":"Resources","allOf":[{"$ref":"#/components/schemas/Role"}],"description":"The list of resources returned by the list or query operation.","union_mode":"left_to_right"}}},"ListResponse_Schema_":{"title":"ListResponse[Schema]","required":["totalResults","itemsPerPage","startIndex","schemas","Resources"],"type":"object","properties":{"totalResults":{"title":"Totalresults","type":"integer","description":"The total number of results returned by the list or query operation."},"itemsPerPage":{"title":"Itemsperpage","type":"integer","description":"The number of resources returned in a list response page."},"startIndex":{"title":"Startindex","type":"integer","description":"The 1-based index of the first result in the current set of list results."},"schemas":{"title":"Schemas","type":"array","items":{"type":"string"},"description":"should be urn:ietf:params:scim:api:messages:2.0:ListResponse"},"Resources":{"title":"Resources","allOf":[{"$ref":"#/components/schemas/Schema"}],"description":"The list of resources returned by the list or query operation.","union_mode":"left_to_right"}}},"ListResponse_ScimResourceType_":{"title":"ListResponse[ScimResourceType]","required":["totalResults","itemsPerPage","startIndex","schemas","Resources"],"type":"object","properties":{"totalResults":{"title":"Totalresults","type":"integer","description":"The total number of results returned by the list or query operation."},"itemsPerPage":{"title":"Itemsperpage","type":"integer","description":"The number of resources returned in a list response page."},"startIndex":{"title":"Startindex","type":"integer","description":"The 1-based index of the first result in the current set of list results."},"schemas":{"title":"Schemas","type":"array","items":{"type":"string"},"description":"should be urn:ietf:params:scim:api:messages:2.0:ListResponse"},"Resources":{"title":"Resources","allOf":[{"$ref":"#/components/schemas/ScimResourceType"}],"description":"The list of resources returned by the list or query operation.","union_mode":"left_to_right"}}},"ListResponse_User_":{"title":"ListResponse[User]","required":["totalResults","itemsPerPage","startIndex","schemas","Resources"],"type":"object","properties":{"totalResults":{"title":"Totalresults","type":"integer","description":"The total number of results returned by the list or query operation."},"itemsPerPage":{"title":"Itemsperpage","type":"integer","description":"The number of resources returned in a list response page."},"startIndex":{"title":"Startindex","type":"integer","description":"The 1-based index of the first result in the current set of list results."},"schemas":{"title":"Schemas","type":"array","items":{"type":"string"},"description":"should be urn:ietf:params:scim:api:messages:2.0:ListResponse"},"Resources":{"title":"Resources","allOf":[{"$ref":"#/components/schemas/User"}],"description":"The list of resources returned by the list or query operation.","union_mode":"left_to_right"}}},"MemberOp":{"title":"MemberOp","type":"object","properties":{"value":{"title":"Value","anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/MemberOpValue"}},{"type":"string"}],"description":"required for add operations"},"path":{"title":"Path","type":"string","description":"required for remove operations, should be members[value eq {user_id}]"},"op":{"title":"Op","type":"string","description":"The operation to perform. Should be Add or Remove / replace"}}},"MemberOpValue":{"title":"MemberOpValue","required":["value"],"type":"object","properties":{"value":{"title":"Value","type":"string","description":"The user ID to add or remove."}}},"Message":{"title":"Message","required":["message"],"type":"object","properties":{"message":{"title":"Message","type":"string"}}},"Op":{"title":"Op","required":["op","value"],"type":"object","properties":{"op":{"title":"Op","type":"string","description":"The operation to perform. Should be Replace."},"path":{"title":"Path","type":"string","description":"The attribute to update. Should be active, displayName, or userName."},"value":{"title":"Value","description":"The new value for the attribute."}}},"Report":{"title":"Report","required":["reportName","reportID"],"type":"object","properties":{"reportName":{"title":"Reportname","type":"string"},"reportID":{"title":"Reportid","type":"string"}}},"ReportList":{"title":"ReportList","required":["linkReportList"],"type":"object","properties":{"linkReportList":{"title":"Linkreportlist","type":"array","items":{"$ref":"#/components/schemas/Report"}}}},"Role":{"title":"Role","type":"object","properties":{"schemas":{"title":"Schemas","type":"array","items":{"enum":["urn:uplifter:schemas:extension:1.0:Role"],"type":"string"},"description":"should be urn:uplifter:schemas:extension:1.0:Role"},"id":{"title":"Id","type":"string","description":"The role value: admin/regular."},"displayName":{"title":"Displayname","type":"string","description":"The display name of the role."},"enabled":{"title":"Enabled","type":"boolean","description":"A Boolean value indicating whether the role is enabled."},"$ref":{"title":"$Ref","type":"string","description":"The URI corresponding to the Role Scim Resource."},"type":{"title":"Type","type":"string","description":"The type of the role."},"resourceType":{"title":"Resourcetype","type":"string","description":"The type of the resource. Should be Role."},"meta":{"title":"Meta","allOf":[{"$ref":"#/components/schemas/ScimMeta"}],"description":"The metadata of the role."},"members":{"title":"Members","type":"array","items":{"$ref":"#/components/schemas/GenericMember"},"description":"The members of the role."}}},"Schema":{"title":"Schema","required":["id","name","description","attributes","meta","schemas"],"type":"object","properties":{"id":{"title":"Id","type":"string","description":"The unique identifier for a schema."},"name":{"title":"Name","type":"string","description":"The name of the schema."},"description":{"title":"Description","type":"string","description":"A description of the schema."},"attributes":{"title":"Attributes","type":"array","items":{"$ref":"#/components/schemas/SchemaAttribute"},"description":"The attributes of the schema."},"meta":{"title":"Meta","allOf":[{"$ref":"#/components/schemas/ScimMeta"}],"description":"Metadata about the schema, including location and resource type name."},"schemas":{"title":"Schemas","type":"array","items":{"enum":["urn:ietf:params:scim:schemas:core:2.0:Schema"],"type":"string"},"description":"should be urn:ietf:params:scim:schemas:core:2.0:Schema"}}},"SchemaAttribute":{"title":"SchemaAttribute","required":["name","type","mutability","returned","uniqueness","caseExact","multiValued","required","description"],"type":"object","properties":{"name":{"title":"Name","type":"string","description":"The name of the attribute."},"type":{"title":"Type","type":"string","description":"The attribute's data type. Should be string, boolean, complex, or array."},"mutability":{"title":"Mutability","type":"string","description":"The mutability of the attribute. Should be readOnly, writeOnly, or readWrite."},"returned":{"title":"Returned","type":"string","description":"The returned value of the attribute. Should be always, never, or default."},"uniqueness":{"title":"Uniqueness","type":"string","description":"The uniqueness of the attribute. Should be none, server, or global."},"caseExact":{"title":"Caseexact","type":"boolean","description":"A Boolean value indicating whether the attribute is case-sensitive."},"multiValued":{"title":"Multivalued","type":"boolean","description":"A Boolean value indicating whether the attribute is multi-valued."},"required":{"title":"Required","type":"boolean","description":"A Boolean value indicating whether the attribute is required."},"description":{"title":"Description","type":"string","description":"A description of the attribute."},"subAttributes":{"title":"Subattributes","type":"array","items":{"$ref":"#/components/schemas/SchemaAttribute"},"description":"The sub-attributes of a complex attribute."}}},"ScimEmail":{"title":"ScimEmail","type":"object","properties":{"value":{"title":"Value","type":"string","description":"The email address. This must match userName."},"type":{"title":"Type","type":"string","description":"A label indicating the type of email (e.g., work, home)."},"primary":{"title":"Primary","type":"boolean","description":"A Boolean value indicating if this is the primary email."}}},"ScimError":{"title":"ScimError","required":["status","detail","schemas"],"type":"object","properties":{"status":{"title":"Status","type":"integer","description":"The HTTP status code."},"detail":{"title":"Detail","type":"string","description":"A detailed error message."},"schemas":{"title":"Schemas","type":"array","items":{"type":"string"},"description":"should be urn:ietf:params:scim:api:messages:2.0:Error"}}},"ScimMeta":{"title":"ScimMeta","type":"object","properties":{"resourceType":{"title":"Resourcetype","type":"string","description":"The resource type. Should be User."},"created":{"title":"Created","type":"string","description":"The date and time the resource was created."},"lastModified":{"title":"Lastmodified","type":"string","description":"The date and time the resource was last modified."},"location":{"title":"Location","type":"string","description":"The URI to get the User https://api.uplifter.tech/scim/v2/Users/{id}"},"version":{"title":"Version","type":"string","description":"The etag for the resource."}}},"ScimName":{"title":"ScimName","type":"object","properties":{"familyName":{"title":"Familyname","type":"string","description":"The user's surname/last/family name."},"givenName":{"title":"Givenname","type":"string","description":"The user's first/Christian/given name."}}},"ScimResourceType":{"title":"ScimResourceType","required":["id","name","description","endpoint","schema","schemas","schemaExtensions","meta"],"type":"object","properties":{"id":{"title":"Id","enum":["Group","User","Entitlement","Role"],"type":"string","description":"The resource type’s unique id."},"name":{"title":"Name","enum":["Group","User","Entitlement","Role"],"type":"string","description":"The resource type name."},"description":{"title":"Description","type":"string","description":"The resource type’s human-readable description."},"endpoint":{"title":"Endpoint","type":"string","description":"The resource type’s HTTP endpoint relative to the Base URL of the service provider, eg, 'Users'."},"schema":{"title":"Schema","type":"string","description":"The resource type’s primary/base schema URI, e.g., 'urn:ietf:params:scim:schemas:core:2.0:User'."},"schemas":{"title":"Schemas","type":"array","items":{"enum":["urn:ietf:params:scim:schemas:core:2.0:ResourceType"],"type":"string"},"description":"should be urn:ietf:params:scim:schemas:core:2.0:ResourceType"},"schemaExtensions":{"title":"Schemaextensions","type":"array","items":{},"description":"A list of schema extensions for the resource type."},"meta":{"title":"Meta","allOf":[{"$ref":"#/components/schemas/ScimMeta"}],"description":"Metadata about the resource type, including location and resource type name."}}},"ServiceProviderAuthenticationScheme":{"title":"ServiceProviderAuthenticationScheme","required":["name","description","specUri","documentationUri","type","primary"],"type":"object","properties":{"name":{"title":"Name","type":"string","description":"The name of the authentication scheme."},"description":{"title":"Description","type":"string","description":"A description of the authentication scheme."},"specUri":{"title":"Specuri","type":"string","description":"The URI to the authentication scheme's specification."},"documentationUri":{"title":"Documentationuri","type":"string","description":"The URI to the authentication scheme's human-readable documentation."},"type":{"title":"Type","type":"string","description":"The type of the authentication scheme."},"primary":{"title":"Primary","type":"boolean","description":"A Boolean value indicating whether the authentication scheme is the primary scheme."}}},"ServiceProviderConfig":{"title":"ServiceProviderConfig","required":["schemas","documentationUri","patch","bulk","filter","changePassword","sort","etag","authenticationSchemes","meta"],"type":"object","properties":{"schemas":{"title":"Schemas","type":"array","items":{"type":"string"},"description":"should be urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"},"documentationUri":{"title":"Documentationuri","type":"string","description":"The URI to the service provider's human-readable documentation."},"patch":{"title":"Patch","allOf":[{"$ref":"#/components/schemas/ServiceProviderSupportedOptions"}],"description":"Indicates if the service provider supports PATCH operations."},"bulk":{"title":"Bulk","allOf":[{"$ref":"#/components/schemas/ServiceProviderSupportedOptions"}],"description":"Indicates if the service provider supports bulk operations."},"filter":{"title":"Filter","allOf":[{"$ref":"#/components/schemas/ServiceProviderSupportedOptions"}],"description":"Indicates if the service provider supports filtering."},"changePassword":{"title":"Changepassword","allOf":[{"$ref":"#/components/schemas/ServiceProviderSupportedOptions"}],"description":"Indicates if the service provider supports changing passwords."},"sort":{"title":"Sort","allOf":[{"$ref":"#/components/schemas/ServiceProviderSupportedOptions"}],"description":"Indicates if the service provider supports sorting."},"etag":{"title":"Etag","allOf":[{"$ref":"#/components/schemas/ServiceProviderSupportedOptions"}],"description":"Indicates if the service provider supports etags."},"authenticationSchemes":{"title":"Authenticationschemes","type":"array","items":{"$ref":"#/components/schemas/ServiceProviderAuthenticationScheme"},"description":"The authentication schemes that the service provider supports."},"meta":{"title":"Meta","allOf":[{"$ref":"#/components/schemas/ScimMeta"}],"description":"The metadata of the service provider."}}},"ServiceProviderSupportedOptions":{"title":"ServiceProviderSupportedOptions","required":["supported"],"type":"object","properties":{"supported":{"title":"Supported","type":"boolean","description":"Indicates if the service provider supports the operation."},"maxOperations":{"title":"Maxoperations","type":"integer","description":"The maximum number of operations in a single request."},"maxPayloadSize":{"title":"Maxpayloadsize","type":"integer","description":"The maximum payload size in bytes."},"maxResults":{"title":"Maxresults","type":"integer","description":"The maximum number of results returned in a single response."}}},"Success":{"title":"Success","required":["code","message"],"type":"object","properties":{"code":{"title":"Code","type":"string"},"message":{"title":"Message","type":"string"}}},"User":{"title":"User","type":"object","properties":{"id":{"title":"Id","type":"string","description":"The unique identifier for a user."},"active":{"title":"Active","type":"boolean","description":"A Boolean value indicating whether the user's account is active."},"externalId":{"title":"Externalid","type":"string","description":"The user's ID in the identity provider."},"userName":{"title":"Username","type":"string","description":"The user's username. (should match email)"},"name":{"title":"Name","allOf":[{"$ref":"#/components/schemas/ScimName"}],"description":"The user's name."},"emails":{"title":"Emails","type":"array","items":{"$ref":"#/components/schemas/ScimEmail"},"description":"The user's email addresses. Should only be one, which must match userName."},"entitlements":{"title":"Entitlements","type":"array","items":{"$ref":"#/components/schemas/Entitlement"},"description":"Workspace + permission entitlements"},"schemas":{"title":"Schemas","type":"array","items":{"enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],"type":"string"},"description":"Must include 'urn:ietf:params:scim:schemas:core:2.0:User'; may also include 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User' if enterprise extension is used."},"meta":{"title":"Meta","allOf":[{"$ref":"#/components/schemas/ScimMeta"}],"description":"The metadata of the user."},"roles":{"title":"Roles","type":"array","items":{"$ref":"#/components/schemas/Role"},"description":"The roles of the user."}}},"UserPatchOp":{"title":"UserPatchOp","type":"object","properties":{"schemas":{"title":"Schemas","type":"array","items":{"type":"string"},"description":"should be urn:ietf:params:scim:api:messages:2.0:PatchOp","default":[]},"Operations":{"title":"Operations","type":"array","items":{"$ref":"#/components/schemas/Op"},"description":"The operations to perform.","default":[]}}},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"type":"string"}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}}}},"tags":[{"name":"Account","description":"Endpoints for account management"},{"name":"Track","description":"Endpoints for the track module"},{"name":"Report","description":"Endpoints for retrieving data from the report module"},{"name":"SCIM_v2","description":"Uplifter provides the following SCIM compatible endpoints for user and group management. If you are implementing for a specific identity provider, documentation on this is available on the [Uplifter Support pages](https://api.uplifter.ai/redoc)."}]}