PDF
Download PDF
Download page User Management APIs.
User Management APIs
{
"openapi": "3.0.1",
"info": {
"title": "",
"version": "v1"
},
"servers": [
{
"url": "https://{baseURL}"
}
],
"paths": {
"/api/user-management/v1/users": {
"post": {
"tags": [
"User Admin"
],
"summary": "Create a user",
"description": "Creates a new user and returns the user's ID.",
"requestBody": {
"description": "User model data to be created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCreateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UserCreateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UserCreateRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"177fd629-1b6c-4d1d-8db6-5aef2357667b","StatusCode":"Created"}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"get": {
"tags": [
"User Admin"
],
"summary": "Get all users",
"description": "Returns all users that meet the criteria.",
"parameters": [
{
"name": "criteria",
"in": "query",
"description": "Search criteria for the users. **For example**: IsActive = 'true'. <p>**Note**: The criteria field (in this case, IsActive) should be indexed.</p>",
"schema": {
"type": "string"
}
},
{
"name": "sortField",
"in": "query",
"description": "Field name for sorting. **For example**: FirstName. <p>**Note**: The sort field (in this case, FirstName) should be indexed or sortable.</p>",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Sort direction (Ascending or Descending) of the data. For example: ASC or DESC. <p>**Note**: The default sort order is **DESC** if the sort field parameter is specified.</p>",
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "The number of records to display on each page.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageNumber",
"in": "query",
"description": "The page number of the result set to view.",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringObjectDictionaryListAPIResponse"
},
"example": {"Success":true,"RecordCount":2,"Data":[{"UserName":"SystemAdmin","Id":"5d21ff42-1e3d-4a27-998f-55b363cf123b","PermissionGroups":"GlobalScopePermissionGroup"},{"UserName":"GeneralUser","Id":"6d16f38d-f8fd-46ce-90b7-3535c42e5642","PermissionGroups":"ScopePermissionGroup"}],"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/users/bulk": {
"post": {
"tags": [
"User Admin"
],
"summary": "Create multiple users",
"description": "Creates multiple users and returns their IDs.<p>**Note**: If a user already exists, the user ID is returned with a validation error.</p>",
"requestBody": {
"description": "Users model data to be created",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCreateRequest"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCreateRequest"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCreateRequest"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"User create request has been processed. Kindly review identity status of user.","StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"patch": {
"tags": [
"User Admin"
],
"summary": "Update multiple users",
"description": "Updates multiple users and returns the updatedUser object.",
"requestBody": {
"description": "Details to be updated in the user model",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkUserUpdateRequest"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkUserUpdateRequest"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkUserUpdateRequest"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponseListAPIResponse"
},
"example": {"Success":true,"Data":[{"FirstName":"Test","LastName":"user","UserName":"TestUser","Email":"systemuser@conga.com","Role":{"Id":"44950272-7be3-48f6-86e6-f7df4e0c0d95","Name":"SysAdmin"},"PermissionGroups":"ScopePermissionGroup","RolePermissionGroups":null,"Timezone":null,"Locale":null,"Currency":null,"CurrencyFormat":null,"IsDeleted":false,"IsActive":true,"IsSuspended":false,"Alias":null,"Language":null,"SmallPhotoUrl":null,"LastLoginDate":null,"Address":"71 ST. NICHOLAS DRIVE","PhoneNumber":null,"IdentityStatus":null,"UserType":"External","AdminPermissions":null,"Id":"f2513f0e-7fd1-485b-b3cb-ac744fc765db","Name":"Test user","CreatedBy":{"Id":"7cac8af2-a6fb-4574-8b37-6283f92b7cfb","Name":"System Admin"},"CreatedDate":"2023-09-29T12:02:44.9571511+00:00","ModifiedBy":{"Id":"8c0bc83b-f026-452e-8380-e24db5ef808c","Name":"System Admin"},"ModifiedDate":"2023-09-29T12:02:44.9571527+00:00","ExternalId":"002i000002AWbWuGFA","ETag":null}],"Errors":[{"Message":"This user doesn't exist. : UserId - dd4e2a8a-be53-464b-b9ce-8c70dd68b326"},{"Message":"Pacific/Midway timezone not exist. : UserId - f6e75dff-e5e4-4696-aeb2-f7e5be99d7e9"}],"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/users/{userId}": {
"put": {
"tags": [
"User Admin"
],
"summary": "Update a user",
"description": "Updates the user information for a specific user.",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "User ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Details to be updated in the user model. **Note**: To see a list of supported numbers, dates, and currency formats, use the *Timezone and Locale APIs* and the *Currency Format APIs*.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserUpdateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UserUpdateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UserUpdateRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponseAPIResponse"
},
"example": {"Success":true,"Data":{"FirstName":"system","LastName":"user","UserName":"DummySystemUser","Email":"dummysystemuser@conga.com","Role":{"Id":"3a6b701e-8949-475c-a10a-2f6564fdbc18","Name":"SysAdmin"},"PermissionGroups":"GlobalScopePermissionGroup","RolePermissionGroups":null,"Timezone":null,"Locale":null,"Currency":null,"CurrencyFormat":null,"IsDeleted":false,"IsActive":true,"IsSuspended":null,"Alias":null,"Language":null,"SmallPhotoUrl":null,"LastLoginDate":null,"Address":"1901 W El Los Angeles","PhoneNumber":null,"IdentityStatus":null,"UserType":"External","AdminPermissions":null,"Id":null,"Name":null,"CreatedBy":{"Id":"14ca80b6-1bb5-4fc9-a220-e6b1c14d0563","Name":"System Admin"},"CreatedDate":"2023-09-29T12:02:44.9644698+00:00","ModifiedBy":{"Id":"5b9f1c53-f54c-4db1-8236-907f8331cc93","Name":"System Admin"},"ModifiedDate":"2023-09-29T12:02:44.9644715+00:00","ExternalId":null,"ETag":null},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"delete": {
"tags": [
"User Admin"
],
"summary": "Inactivate a user",
"description": "Deactivates a user and returns the status.",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "User ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"User InActivate request has been processed. Kindly review identity status of user.","StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"get": {
"tags": [
"User Admin"
],
"summary": "Get user details by user ID",
"description": "Returns the details of a user based on the user ID.",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "User ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponseAPIResponse"
},
"example": {"Success":true,"Data":{"FirstName":"system","LastName":"user","UserName":"SystemUser","Email":"systemuser@conga.com","Role":{"Id":"a5a9701e-72b3-4fb2-81e5-4293ee01f7ec","Name":"SysAdmin"},"PermissionGroups":"ScopePermissionGroup","RolePermissionGroups":null,"Timezone":null,"Locale":null,"Currency":null,"CurrencyFormat":null,"IsDeleted":false,"IsActive":true,"IsSuspended":null,"Alias":null,"Language":null,"SmallPhotoUrl":null,"LastLoginDate":null,"Address":"71 ST. NICHOLAS DRIVE","PhoneNumber":null,"IdentityStatus":null,"UserType":"External","AdminPermissions":null,"Id":null,"Name":null,"CreatedBy":{"Id":"d561d0ca-4d5f-43cd-af8e-e8715a69b21c","Name":"System Admin"},"CreatedDate":"2023-09-29T12:02:44.9664146+00:00","ModifiedBy":{"Id":"e99928fa-5843-48c1-aaaf-738f2bdf6599","Name":"System Admin"},"ModifiedDate":"2023-09-29T12:02:44.9664156+00:00","ExternalId":null,"ETag":null},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/users/upload": {
"post": {
"tags": [
"User Admin"
],
"summary": "Upload users",
"description": "Accepts a .csv file containing user records as input, creates users, and returns the IDs for all newly created users.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"usersDataFile": {
"type": "string",
"format": "binary"
}
}
},
"encoding": {
"usersDataFile": {
"style": "form"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"User create request has been processed. Kindly review identity status of user.","StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/users/{userId}/clone": {
"post": {
"tags": [
"User Admin"
],
"summary": "Clone a user",
"description": "Clones the user based on the user ID and returns the cloned user's ID.",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "User ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Request model containing ExternalId and Email fields for cloning a user.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserCloneRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UserCloneRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UserCloneRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"f04d29ef-135a-402b-9301-eee378d040e3","StatusCode":"Created"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/users/{userId}/restore": {
"put": {
"tags": [
"User Admin"
],
"summary": "Restore an inactivated user",
"description": "Based on the user ID, restores the user (if it is deactivated user) and sends the message to auth.",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "User ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"User Activate request has been processed. Kindly review identity status of user.","StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/users/templates/download": {
"get": {
"tags": [
"User Admin"
],
"summary": "Get CSV format for user upload",
"description": "Fetches the most recent user metadata, generates a .csv file with all of the user fields, and returns a template for uploading users for download.",
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success"
}
}
}
},
"/api/user-management/v1/users/{userId}/roles": {
"get": {
"tags": [
"User Admin"
],
"summary": "Get a user's role",
"description": "Retrieves a user's role based on the user ID and returns the status as the role name.",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "User ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"SystemAdmin","StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/users/{userId}/roles/{roleId}/exists": {
"get": {
"tags": [
"User Admin"
],
"summary": "Check if a user is assigned a role",
"description": "Using a user ID and a role ID, returns true or false depending on whether the user is assigned a role or not.",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "User ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "roleId",
"in": "path",
"description": "Role ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanNullableAPIResponse"
},
"example": {"Success":true,"Data":true,"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/users/{userId}/roles/{roleId}": {
"put": {
"tags": [
"User Admin"
],
"summary": "Update a user's role",
"description": "Updates a user's role based on the user ID and role ID passed in.",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "User ID to whom the role is to be assigned",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "roleId",
"in": "path",
"description": "Role ID that is to be assigned to the specified user.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponseAPIResponse"
},
"example": {"Success":true,"Data":{"FirstName":"system","LastName":"user","UserName":"SystemUser","Email":"systemuser@conga.com","Role":{"Id":"fb6ecc7d-ba8e-4849-88a9-e28d2a09182d","Name":"ContractFacilitator"},"PermissionGroups":"ScopePermissionGroup","RolePermissionGroups":null,"Timezone":null,"Locale":null,"Currency":null,"CurrencyFormat":null,"IsDeleted":false,"IsActive":true,"IsSuspended":null,"Alias":null,"Language":null,"SmallPhotoUrl":null,"LastLoginDate":null,"Address":"71 ST. NICHOLAS DRIVE","PhoneNumber":null,"IdentityStatus":null,"UserType":"External","AdminPermissions":null,"Id":null,"Name":null,"CreatedBy":{"Id":"70e39245-f50e-4a63-b17c-c3ab71ff1dbf","Name":"System Admin"},"CreatedDate":"2023-09-29T12:02:44.9750312+00:00","ModifiedBy":{"Id":"73acd7c3-2984-49ee-ba20-0a51689adba5","Name":"System Admin"},"ModifiedDate":"2023-09-29T12:02:44.9750326+00:00","ExternalId":null,"ETag":null},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/users/{userId}/permissiongroups": {
"put": {
"tags": [
"User Admin"
],
"summary": "Assign permission group to a user",
"description": "Appends the permission group name to the provided user's current permission groups and returns the updatedUser object.",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "User ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The list of permission groups to be assigned for a user.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignPermissionGroups"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AssignPermissionGroups"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AssignPermissionGroups"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponseAPIResponse"
},
"example": {"Success":true,"Data":{"FirstName":"system","LastName":"user","UserName":"SystemUser","Email":"systemuser@conga.com","Role":{"Id":"15a3454e-6102-4a97-a838-abb006b96df1","Name":"SysAdmin"},"PermissionGroups":"ScopePermissionGroup","RolePermissionGroups":null,"Timezone":null,"Locale":null,"Currency":null,"CurrencyFormat":null,"IsDeleted":false,"IsActive":true,"IsSuspended":null,"Alias":null,"Language":null,"SmallPhotoUrl":null,"LastLoginDate":null,"Address":"71 ST. NICHOLAS DRIVE","PhoneNumber":null,"IdentityStatus":null,"UserType":"External","AdminPermissions":null,"Id":null,"Name":null,"CreatedBy":{"Id":"0cbaea19-b511-4234-8cf6-b993a2da807e","Name":"System Admin"},"CreatedDate":"2023-09-29T12:02:44.9763171+00:00","ModifiedBy":{"Id":"d3904938-6ab0-420b-8cdf-8c42d4ac480f","Name":"System Admin"},"ModifiedDate":"2023-09-29T12:02:44.976318+00:00","ExternalId":null,"ETag":null},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"delete": {
"tags": [
"User Admin"
],
"summary": "Delete permission groups from a user",
"description": "Removes the permission group names from the provided user's current permission groups and returns the updatedUser object along with error messages for invalid records.",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "User ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The list of permission groups to be deleted from a user.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletePermissionGroups"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeletePermissionGroups"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeletePermissionGroups"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponseAPIResponse"
},
"example": {"Success":true,"Data":{"FirstName":"system","LastName":"user","UserName":"SystemUser","Email":"systemuser@conga.com","Role":{"Id":"bf4b95a5-fcab-46a9-b725-f7ed2027b8ee","Name":"SysAdmin"},"PermissionGroups":"ScopePermissionGroup","RolePermissionGroups":null,"Timezone":null,"Locale":null,"Currency":null,"CurrencyFormat":null,"IsDeleted":false,"IsActive":true,"IsSuspended":null,"Alias":null,"Language":null,"SmallPhotoUrl":null,"LastLoginDate":null,"Address":"71 ST. NICHOLAS DRIVE","PhoneNumber":null,"IdentityStatus":null,"UserType":"External","AdminPermissions":null,"Id":null,"Name":null,"CreatedBy":{"Id":"6dfb8563-65e5-4259-960c-4d3c4640c88c","Name":"System Admin"},"CreatedDate":"2023-09-29T12:02:44.9776474+00:00","ModifiedBy":{"Id":"13435dc1-4ace-4e5e-b3a1-380a1bc9610e","Name":"System Admin"},"ModifiedDate":"2023-09-29T12:02:44.9776483+00:00","ExternalId":null,"ETag":null},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/roles": {
"post": {
"tags": [
"Role Admin"
],
"summary": "Create a new role",
"description": "Creates a new role and returns the role's ID.",
"requestBody": {
"description": "Details about a role",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleCreateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RoleCreateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RoleCreateRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"70136355-7b5d-43ab-a511-3ac16c842df7","StatusCode":"Created"}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"get": {
"tags": [
"Role Admin"
],
"summary": "Get all roles",
"description": "Returns all roles that meet the criteria.",
"parameters": [
{
"name": "criteria",
"in": "query",
"description": "Search criteria for the roles. **For example**: IsDeleted != 'true'.<p>**Note**: The criteria field (in this case, IsDeleted) should be indexed.</p>",
"schema": {
"type": "string"
}
},
{
"name": "sortField",
"in": "query",
"description": "Field name for sorting. **For example**: Name.<p>**Note**: The sort field (in this case, Name) should be indexed or sortable.</p>",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Sort direction (Ascending or Descending) of the data. For example: ASC or DESC<p>**Note**: The default sort order is **DESC** if the sort field parameter is specified.</p>",
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "The number of records to display on each page.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageNumber",
"in": "query",
"description": "The page number of the result set to view.",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringObjectDictionaryListAPIResponse"
},
"example": {"Success":true,"RecordCount":2,"Data":[{"Description":"GeneralUserRole","Id":"e3b24c1b-f7a3-473a-a4fe-cb5be8d6df34","PermissionGroups":"GlobalScopePermissionGroup","Name":"GeneralUser"},{"Description":"Admin","Id":"da8594b9-07ea-4c20-a814-fcb29f870a77","PermissionGroups":"ScopePermissionGroup","Name":"Admin"}],"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/roles/bulk": {
"post": {
"tags": [
"Role Admin"
],
"summary": "Create multiple roles",
"description": "Creates multiple roles and returns their IDs.",
"requestBody": {
"description": "Details about roles",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleCreateRequest"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleCreateRequest"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleCreateRequest"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringListAPIResponse"
},
"example": {"Success":true,"Data":["730e614f-2f9c-415a-8955-7a624a1fac09","aedcbff4-6861-4fd2-bc3a-1aaf42ce769d"],"StatusCode":"Created"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/roles/{roleId}": {
"put": {
"tags": [
"Role Admin"
],
"summary": "Update a role",
"description": "Updates the name and description of the provided role ID.",
"parameters": [
{
"name": "roleId",
"in": "path",
"description": "Role ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Details to be updated in the role model",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleUpdateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RoleUpdateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RoleUpdateRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleAPIResponse"
},
"example": {"Success":true,"Data":{"Description":"GeneralUserRole","PermissionGroups":"GlobalScopePermissionGroup","IsDeleted":false,"AdminPermissions":null,"Id":"260b608c-2140-4400-ae09-a412ae837987","Name":"GeneralUser","CreatedBy":null,"CreatedDate":"2023-09-29T12:02:44.9879502+00:00","ModifiedBy":null,"ModifiedDate":"2023-09-29T12:02:44.9879507+00:00","ExternalId":null,"ETag":null},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"delete": {
"tags": [
"Role Admin"
],
"summary": "Delete a role",
"description": "Deletes the role with the given role ID and returns the status.",
"parameters": [
{
"name": "roleId",
"in": "path",
"description": "Role ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"5e86a8a2-1ee0-4561-8199-f72767593a99 deleted successfully.","StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"get": {
"tags": [
"Role Admin"
],
"summary": "Get role information by ID",
"description": "Returns the details of a role based on the role ID.",
"parameters": [
{
"name": "roleId",
"in": "path",
"description": "Role ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleAPIResponse"
},
"example": {"Success":true,"Data":{"Description":"GeneralUserRole","PermissionGroups":"GlobalScopePermissionGroup","IsDeleted":false,"AdminPermissions":null,"Id":"bf8ae307-00b4-4763-9520-003da2cf6a57","Name":"GeneralUser","CreatedBy":{"Id":"2c1857ab-0a5f-435e-a0f4-6d71d9d781aa","Name":"System Admin"},"CreatedDate":"2023-09-29T12:02:44.9897701+00:00","ModifiedBy":{"Id":"53799a4f-140e-41e4-b411-fb60afbeca47","Name":"System Admin"},"ModifiedDate":"2023-09-29T12:02:44.9897712+00:00","ExternalId":null,"ETag":null},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/roles/{roleId}/exists": {
"get": {
"tags": [
"Role Admin"
],
"summary": "Check whether the role exists",
"description": "Uses the role ID as an input to check whether the role exists.",
"parameters": [
{
"name": "roleId",
"in": "path",
"description": "Role ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanNullableAPIResponse"
},
"example": {"Success":true,"Data":true,"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/roles/{roleId}/permissiongroups": {
"put": {
"tags": [
"Role Admin"
],
"summary": "Assign permission groups to a role",
"description": "Appends the permission group names to the provided role's current permission groups and returns the updated role.",
"parameters": [
{
"name": "roleId",
"in": "path",
"description": "Role ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The list of permission groups to be assigned for the role",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignPermissionGroups"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AssignPermissionGroups"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AssignPermissionGroups"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleAPIResponse"
},
"example": {"Success":true,"Data":{"Description":"GeneralUserRole","PermissionGroups":"GlobalScopePermissionGroup","IsDeleted":false,"AdminPermissions":null,"Id":"f8814279-0f6e-4c40-8297-6a2f09b0e69d","Name":"GeneralUser","CreatedBy":{"Id":"e40453a2-3500-4ddb-ac8a-e3172b3422d7","Name":"System Admin"},"CreatedDate":"2023-09-29T12:02:44.99168+00:00","ModifiedBy":{"Id":"666eb07e-4e7c-415c-bb3e-688f3112fd47","Name":"System Admin"},"ModifiedDate":"2023-09-29T12:02:44.9916811+00:00","ExternalId":null,"ETag":null},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"delete": {
"tags": [
"Role Admin"
],
"summary": "Delete permission groups from a role",
"description": "Removes the permission group names from the provided role's current permission groups and returns the updated role along with error messages for invalid records.",
"parameters": [
{
"name": "roleId",
"in": "path",
"description": "Role ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The list of permission groups to be deleted from a role.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletePermissionGroups"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeletePermissionGroups"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeletePermissionGroups"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/roles/{roleId}/clone": {
"post": {
"tags": [
"Role Admin"
],
"summary": "Clone a role",
"description": "Clones the role based on the role ID and returns the cloned role's ID.",
"parameters": [
{
"name": "roleId",
"in": "path",
"description": "Role ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleCloneRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RoleCloneRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RoleCloneRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"34fd8250-9894-4df6-a900-0ceddd5de2da","StatusCode":"Created"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/roles/{roleId}/admin-permissions": {
"put": {
"tags": [
"Role Admin"
],
"summary": "Assign admin permissions to a role",
"description": "Appends the admin permission to the provided role's current admin permissions and returns the updated role.",
"parameters": [
{
"name": "roleId",
"in": "path",
"description": "Role ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The list of admin permissions to be assigned for role. *Note*: Use the *Admin Permissions API* to list admin permissions available in the data storage.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignAdminPermissions"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AssignAdminPermissions"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AssignAdminPermissions"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleAPIResponse"
},
"example": {"Success":true,"Data":{"Description":"CLMRole","PermissionGroups":"CLMPermissionGroup","IsDeleted":false,"AdminPermissions":"SchemaManager,Templates","Id":"32885ea8-eec1-4b91-946e-a17a3e909029","Name":"CLMRole","CreatedBy":{"Id":"70ccadb3-e100-4d33-987f-f0260e2bca3c","Name":"System Admin"},"CreatedDate":"2023-09-29T12:02:44.9950376+00:00","ModifiedBy":{"Id":"98ecd579-f80b-4b3d-886e-54c84d46e016","Name":"System Admin"},"ModifiedDate":"2023-09-29T12:02:44.9950387+00:00","ExternalId":null,"ETag":null},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"delete": {
"tags": [
"Role Admin"
],
"summary": "Delete admin permissions from a role",
"description": "Removes the admin permissions from the provided role's current admin permissions and returns the updated role.",
"parameters": [
{
"name": "roleId",
"in": "path",
"description": "Role ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The list of admin permissions to be deleted from a role. *Note*: Use the *Get role information by ID* API to list a role's available admin permissions.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteAdminPermissions"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteAdminPermissions"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteAdminPermissions"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleAPIResponse"
},
"example": {"Success":true,"Data":{"Description":"CLMRole","PermissionGroups":"CLMPermissionGroup","IsDeleted":false,"AdminPermissions":"Templates","Id":"80786e6d-c04e-4cb9-a0dc-000d549911f3","Name":"CLMRole","CreatedBy":{"Id":"229468c4-4a7e-4b4e-bc3b-114510f037ad","Name":"System Admin"},"CreatedDate":"2023-09-29T12:02:44.9962802+00:00","ModifiedBy":{"Id":"1cdd94d6-ff20-4411-9dc5-80f8364abb26","Name":"System Admin"},"ModifiedDate":"2023-09-29T12:02:44.9962812+00:00","ExternalId":null,"ETag":null},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/admin-permissions": {
"get": {
"tags": [
"AdminPermissions"
],
"summary": "Get the master list of admin permissions",
"description": "Returns the master list of admin permissions from the data storage.",
"responses": {
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminPermissionsAPIResponse"
},
"example": {"Success":true,"Data":{"AdminPermissionsList":[{"Value":"SchemaManager","DisplayName":"Schema Manager","Description":"Manage schema definition"},{"Value":"Templates","DisplayName":"Templates","Description":"Manage Email Templates"}]},"StatusCode":"OK"}
}
}
}
}
}
},
"/api/user-management/v1/permissiongroups": {
"get": {
"tags": [
"Permission Groups"
],
"summary": "Get the master list of permission groups",
"description": "Returns the master list of permission groups from data storage.",
"responses": {
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PermissionGroupsAPIResponse"
},
"example": {"Success":true,"Data":{"PermissionGroupNamesList":[{"DisplayValue":"PermissionGroup1","Value":"PermissionGroup1","Description":"sample permission group for description"},{"DisplayValue":"PermissionGroup2","Value":"PermissionGroup2","Description":"sample permission group for description"}]},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"post": {
"tags": [
"Permission Groups"
],
"summary": "Add permission group names to the master list",
"description": "Adds permission group names to the master list and returns the updated list of permission groups.",
"requestBody": {
"description": "A list of permission groups to be added to the master list.<p>**Note:** The permission group name must be unique and no longer than 80 characters.</p>",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PermissionGroupsCreateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PermissionGroupsCreateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PermissionGroupsCreateRequest"
}
}
}
},
"responses": {
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PermissionGroupsAPIResponse"
},
"example": {"Success":true,"Data":{"PermissionGroupNamesList":[{"DisplayValue":"PermissionGroup1","Value":"PermissionGroup1","Description":"sample permission group for description"},{"DisplayValue":"PermissionGroup2","Value":"PermissionGroup2","Description":"sample permission group for description"}]},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"delete": {
"tags": [
"Permission Groups"
],
"summary": "Delete permission groups",
"description": "Removes permission group names from the stored master list, as well as any associated object, action, or scope permissions granted to that permission group if no user or role is associated with it, and returns a list of the deleted permission group's IDs and error messages for invalid records.",
"requestBody": {
"description": "A list of permission groups to be deleted from the master list.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PermissionGroupsDeleteRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PermissionGroupsDeleteRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PermissionGroupsDeleteRequest"
}
}
}
},
"responses": {
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"20086a98-2c8d-4bc7-9fe8-fb5cb84e319d,c60f5c56-e44d-4694-b684-74ee3403fdd9 deleted successfully.","StatusCode":"OK"}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/organization/info": {
"patch": {
"tags": [
"Organization"
],
"summary": "Update organization's information",
"description": "Updates organization's information.",
"requestBody": {
"description": "Organization's information to be updated. **Note**: To see a list of supported numbers, dates, and currency formats, use the *Timezone and Locale APIs* and the *Currency Format APIs*.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationUpdateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationUpdateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OrganizationUpdateRequest"
}
}
}
},
"responses": {
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
},
"400": {
"description": "Bad Request"
}
}
},
"get": {
"tags": [
"Organization"
],
"summary": "Get organization's information",
"description": "Returns the organization's information.",
"responses": {
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/organization/locale": {
"get": {
"tags": [
"Organization"
],
"summary": "Get organization's locale",
"description": "Returns the organization's locale.",
"responses": {
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/organization/timezone": {
"get": {
"tags": [
"Organization"
],
"summary": "Get organization's time zone",
"description": "Returns the organization's time zone.",
"responses": {
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/organization/currency": {
"get": {
"tags": [
"Organization"
],
"summary": "Get organization's currency",
"description": "Returns the organization's currency.",
"responses": {
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/integrations/{externalIntegrationId}": {
"put": {
"tags": [
"Organization External Integration"
],
"summary": "Update external identifiers",
"description": "Updates an organization's external integration and adds external identifiers.",
"parameters": [
{
"name": "externalIntegrationId",
"in": "path",
"description": "Organization ID is the external integration ID. It is onboarded as 'OrganizationID' from the organization's demographics.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Details about external organization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationExternalIntegrationCreateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationExternalIntegrationCreateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/OrganizationExternalIntegrationCreateRequest"
}
}
}
},
"responses": {
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
},
"400": {
"description": "Bad Request"
}
}
},
"delete": {
"tags": [
"Organization External Integration"
],
"summary": "Remove external identifiers",
"description": "Updates an organization external integration and removes external identifiers.",
"parameters": [
{
"name": "externalIntegrationId",
"in": "path",
"description": "Organization ID is the external integration ID. It is onboarded as 'OrganizationID' from the organization's demographics.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Unique record IDs of external system",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
},
"400": {
"description": "Bad Request"
}
}
},
"get": {
"tags": [
"Organization External Integration"
],
"summary": "Get external identifiers",
"description": "Returns the external identifiers of an external integration.",
"parameters": [
{
"name": "externalIntegrationId",
"in": "path",
"description": "Organization ID is the external integration ID. It is onboarded as 'OrganizationID' from the organization's demographics.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sortField",
"in": "query",
"description": "Field name for sorting. **For example**: Type.<p>**Note**: The sort field (in this case, Type) should be indexed or sortable.</p>",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Sort direction (Ascending or Descending) of the data. For example: ASC or DESC<p>**Note**: The default sort order is **DESC** if the sort field parameter is specified.</p>",
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "The number of records to return. Default value: 10.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageNumber",
"in": "query",
"description": "The page number of the result set to view.",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/integrations/identiy-providers": {
"get": {
"tags": [
"Organization External Integration"
],
"summary": "Get all identity providers (IDPs)",
"description": "Retrieves all identity providers.",
"responses": {
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IDPMasterListAPIResponse"
},
"example": {"Success":true,"Data":[{"Name":"Salesforce","ACRName":"idp:Salesforce"},{"Name":"Salesforce Sandbox","ACRName":"idp:SalesforceSandbox"},{"Name":"Microsoft","ACRName":"idp:Microsoft"}],"StatusCode":"OK"}
}
}
}
}
}
},
"/api/user-management/v1/api-connections/{externalIdentifier}": {
"post": {
"tags": [
"API Connections"
],
"summary": "Add API connection",
"description": "Adds API connection.",
"parameters": [
{
"name": "externalIdentifier",
"in": "path",
"description": "External identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "apiConnectionType",
"in": "query",
"description": "API connection type",
"schema": {
"$ref": "#/components/schemas/APIConnectionType"
}
}
],
"requestBody": {
"description": "Input for creating an API connection.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIConnectionCreateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/APIConnectionCreateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/APIConnectionCreateRequest"
}
}
}
},
"responses": {
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIConnectionAPIResponse"
},
"example": {"Success":true,"Data":{"APIType":"API to API","ClientId":"000000000000-000000000000.apps.googleusercontent.com","ClientName":"ClientA","Description":"ClientA Description","IsActive":true,"ExternalIdentifier":"ABCDEFGHI123456789","CorsOrigins":null,"BackChannelLogoutURI":null,"FrontChannelLogoutURI":null,"RedirectURI":null,"ClientSecret":null},"StatusCode":"OK"}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"put": {
"tags": [
"API Connections"
],
"summary": "Update API connection",
"description": "Updates API connection.",
"parameters": [
{
"name": "externalIdentifier",
"in": "path",
"description": "External identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "apiConnectionType",
"in": "query",
"description": "API connection type",
"schema": {
"$ref": "#/components/schemas/APIConnectionType"
}
}
],
"requestBody": {
"description": "Input for updating an API connection.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIConnectionCreateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/APIConnectionCreateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/APIConnectionCreateRequest"
}
}
}
},
"responses": {
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIConnectionAPIResponse"
},
"example": {"Success":true,"Data":{"APIType":"API to API","ClientId":"000000000000-000000000000.apps.googleusercontent.com","ClientName":"ClientA","Description":"ClientA Description","IsActive":true,"ExternalIdentifier":"ABCDEFGHI123456789","CorsOrigins":null,"BackChannelLogoutURI":null,"FrontChannelLogoutURI":null,"RedirectURI":null,"ClientSecret":null},"StatusCode":"OK"}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"get": {
"tags": [
"API Connections"
],
"summary": "Get API connections",
"description": "Retrieves API connections based on the API connection type selected.",
"parameters": [
{
"name": "externalIdentifier",
"in": "path",
"description": "External identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "apiConnectionType",
"in": "query",
"description": "API connection type",
"schema": {
"$ref": "#/components/schemas/APIConnectionType"
}
}
],
"responses": {
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIConnectionAPIResponse"
},
"example": {"Success":true,"Data":{"APIType":"API to API","ClientId":"000000000000-000000000000.apps.googleusercontent.com","ClientName":"ClientA","Description":"ClientA Description","IsActive":true,"ExternalIdentifier":"ABCDEFGHI123456789","CorsOrigins":null,"BackChannelLogoutURI":null,"FrontChannelLogoutURI":null,"RedirectURI":null,"ClientSecret":null},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/api-connections": {
"get": {
"tags": [
"API Connections"
],
"summary": "Get all API connections",
"description": "Retrieves all API connections.",
"parameters": [
{
"name": "sortField",
"in": "query",
"description": "Field name for sorting. **For example**: APIType.<p>**Note**: The sort field (in this case, APIType) should be indexed or sortable.</p>",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Sort direction (Ascending or Descending) of the data. For example: ASC or DESC<p>**Note**: The default sort order is **DESC** if the sort field parameter is specified.</p>",
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "The number of records to display on each page.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageNumber",
"in": "query",
"description": "The page number of the result set to view.",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIConnectionListAPIResponse"
},
"example": {"Success":true,"Data":[{"APIType":"API to API","ClientId":"SampleClientId","ClientName":"ClientA","Description":"ClientA Description","IsActive":true,"ExternalIdentifier":"ABCDEFGHI123456789","CorsOrigins":null,"BackChannelLogoutURI":null,"FrontChannelLogoutURI":null,"RedirectURI":null,"ClientSecret":null},{"APIType":"UI to API","ClientId":"SampleClientId","ClientName":"ClientB","Description":"ClientB Description","IsActive":true,"ExternalIdentifier":"ABCDEFGHI123456789","CorsOrigins":["http://localhost:3000"],"BackChannelLogoutURI":"","FrontChannelLogoutURI":"","RedirectURI":["https://www.sampleabc.com/"],"ClientSecret":null}],"StatusCode":"OK"}
}
}
}
}
}
},
"/api/user-management/v1/api-connections/{externalIdentifier}/status": {
"put": {
"tags": [
"API Connections"
],
"summary": "Update API connection status",
"description": "Updates the status of the API connection.",
"parameters": [
{
"name": "externalIdentifier",
"in": "path",
"description": "External identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "apiConnectionType",
"in": "query",
"description": "API connection type",
"schema": {
"$ref": "#/components/schemas/APIConnectionType"
}
}
],
"requestBody": {
"description": "Input for updating the API connection status.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAPIConnectionStatusRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAPIConnectionStatusRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateAPIConnectionStatusRequest"
}
}
}
},
"responses": {
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanNullableAPIResponse"
},
"example": {"Success":true,"Data":true,"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
},
"400": {
"description": "Bad Request"
}
}
}
},
"/api/user-management/v1/user/guest": {
"post": {
"tags": [
"Guest User"
],
"summary": "Create a guest user",
"description": "Creates a guest user and returns the guest user's ID.",
"requestBody": {
"description": "Guest user model data to be created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuestUserCreateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GuestUserCreateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GuestUserCreateRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"72dc3867-2afd-4ad2-9d12-471883304d1e","StatusCode":"Created"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/user/guest/{userId}": {
"put": {
"tags": [
"Guest User"
],
"summary": "Update a guest user",
"description": "Updates the user information for a specific guest user.",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "Guest user ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Details to be updated in the guest user model. **Note**: To see a list of supported numbers, dates, and currency formats, use the *Timezone and Locale APIs* and the *Currency Format APIs*.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuestUserUpdateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GuestUserUpdateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GuestUserUpdateRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponseAPIResponse"
},
"example": {"Success":true,"Data":{"FirstName":"system","LastName":"user","UserName":"DummySystemUser","Email":"dummysystemuser@conga.com","Role":{"Id":"f6b1a2dc-bb55-4d13-90c7-9c8597775604","Name":"GuestUserRole"},"PermissionGroups":"GlobalScopePermissionGroup","RolePermissionGroups":null,"Timezone":null,"Locale":null,"Currency":null,"CurrencyFormat":null,"IsDeleted":false,"IsActive":true,"IsSuspended":null,"Alias":null,"Language":null,"SmallPhotoUrl":null,"LastLoginDate":null,"Address":"1901 W El Los Angeles","PhoneNumber":null,"IdentityStatus":null,"UserType":"Guest","AdminPermissions":null,"Id":null,"Name":null,"CreatedBy":{"Id":"b3e78d86-f41e-4f30-8c8e-3d1d40c8a9cd","Name":"System Admin"},"CreatedDate":"2023-09-29T12:02:45.0237321+00:00","ModifiedBy":{"Id":"d0231fe8-c3b7-43a1-8542-8d1b096aff76","Name":"System Admin"},"ModifiedDate":"2023-09-29T12:02:45.0237332+00:00","ExternalId":null,"ETag":null},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"delete": {
"tags": [
"Guest User"
],
"summary": "Inactivate a guest user",
"description": "Deactivates a guest user and returns the status.",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "Guest user ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"User InActivate request has been processed. Kindly review identity status of user.","StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/user/guest/{userId}/restore": {
"put": {
"tags": [
"Guest User"
],
"summary": "Restore an inactivated user",
"description": "Based on the guest user ID, restores the guest user (if it is deactivated user) and sends the message to auth.",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "Guest user ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"User Activate request has been processed. Kindly review identity status of user.","StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/objectpermissions": {
"post": {
"tags": [
"Object Permission"
],
"summary": "Create a new object permission",
"description": "Creates a new object permission and returns the object permission's ID.",
"requestBody": {
"description": "Object permission model data to be created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectPermissionCreateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ObjectPermissionCreateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ObjectPermissionCreateRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"8de9cc0b-66f9-43e0-ba89-0d5654345fbc","StatusCode":"Created"}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"get": {
"tags": [
"Object Permission"
],
"summary": "Get all object permissions",
"description": "Returns all object permissions that meet the criteria.",
"parameters": [
{
"name": "criteria",
"in": "query",
"description": "Search criteria for the object permissions. **For example**: IsActive = 'true'.<p>**Note**: The criteria field (in this case, IsDeleted) should be indexed.</p>",
"schema": {
"type": "string"
}
},
{
"name": "sortField",
"in": "query",
"description": "Field name for sorting. **For example**: ObjectName.<p>**Note**: The sort field (in this case, ObjectName) should be indexed or sortable.</p>",
"schema": {
"type": "string"
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Sort direction (Ascending or Descending) of the data. For example: ASC or DESC<p>**Note**: The default sort order is **DESC** if the sort field parameter is specified.</p>",
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "The number of records to display on each page. Default page size is 100.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageNumber",
"in": "query",
"description": "The page number of the result set to view.",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/objectpermissions/bulk": {
"post": {
"tags": [
"Object Permission"
],
"summary": "Create multiple object permissions",
"description": "Creates multiple object permissions and returns their IDs.",
"requestBody": {
"description": "Object permissions model data to be created",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectPermissionCreateRequest"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectPermissionCreateRequest"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectPermissionCreateRequest"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringListAPIResponse"
},
"example": {"Success":true,"Data":["d0697f02-f3bb-4b9b-80fa-668aa07292bb","fd8e1134-ad0a-4668-8e02-f10a41937771"],"StatusCode":"Created"}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"delete": {
"tags": [
"Object Permission"
],
"summary": "Delete multiple object permission records",
"description": "Removes multiple object permission records and returns a list of the deleted object permission's IDs as well as error messages for invalid records.",
"requestBody": {
"description": "Multiple object permission IDs to be deleted",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success"
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/objectpermissions/{objectPermissionId}": {
"get": {
"tags": [
"Object Permission"
],
"summary": "Get object permission details by ID",
"description": "Fetches the object permission details based on the object permission ID.",
"parameters": [
{
"name": "objectPermissionId",
"in": "path",
"description": "Object permission ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectPermissionAPIResponse"
},
"example": {"Success":true,"Data":{"ObjectName":"SampleObjectName","PermissionGroupName":"SamplePermissionGroupName","ViewAll":true,"ModifyAll":false,"ActionPermissions":"{\"CREATE\":{\"Standard\":true,\"Enabled\":true,\"Criteria\":\"\"},\"UPDATE\":{\"Standard\":true,\"Enabled\":true,\"Criteria\":\"\"},\"DELETE\":{\"Standard\":true,\"Enabled\":false,\"Criteria\":\"\"},\"READ\":{\"Standard\":true,\"Enabled\":true,\"Criteria\":\"\"}}","ScopePermissions":"{\"GLOBAL\":\"\",\"USER\":[],\"ACCOUNT\":null,\"CONTACT\":\"\"}","IsDeleted":false,"Id":"47bd5ad1-5180-4291-a96e-6bb9f60c5cf8","Name":"SampleObjectName.SamplePermissionGroupName","CreatedBy":{"Id":"ec13e269-1a25-4dc6-b4cf-39487d4a6057","Name":"System Admin"},"CreatedDate":"2023-09-29T12:02:45.0341764+00:00","ModifiedBy":{"Id":"78bbe9b2-9575-40eb-be99-5d6cf53b47fa","Name":"System Admin"},"ModifiedDate":"2023-09-29T12:02:45.034178+00:00","ExternalId":"81c2218e-39fd-41ff-b3d4-bc85ce1e1f82","ETag":null},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"put": {
"tags": [
"Object Permission"
],
"summary": "Update an object permission",
"description": "Updates an object permission and returns updated object permission details.",
"parameters": [
{
"name": "objectPermissionId",
"in": "path",
"description": "Object permission ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Details to be updated in the object permission model",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectPermissionUpdateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ObjectPermissionUpdateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ObjectPermissionUpdateRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectPermissionAPIResponse"
},
"example": {"Success":true,"Data":{"ObjectName":"SampleObjectName","PermissionGroupName":"SamplePermissionGroupName","ViewAll":true,"ModifyAll":false,"ActionPermissions":"{\"CREATE\":{\"Standard\":true,\"Enabled\":true,\"Criteria\":\"\"},\"UPDATE\":{\"Standard\":true,\"Enabled\":true,\"Criteria\":\"\"},\"DELETE\":{\"Standard\":true,\"Enabled\":false,\"Criteria\":\"\"},\"READ\":{\"Standard\":true,\"Enabled\":true,\"Criteria\":\"\"}}","ScopePermissions":"{\"GLOBAL\":\"\",\"USER\":[],\"ACCOUNT\":null,\"CONTACT\":\"\"}","IsDeleted":false,"Id":"2d53861d-25f6-4658-8e30-1aa6145f6bf5","Name":"SampleObjectName.SamplePermissionGroupName","CreatedBy":{"Id":"a9942bff-a51e-4742-8aee-ec9946b6d192","Name":"System Admin"},"CreatedDate":"2023-09-29T12:02:45.0362152+00:00","ModifiedBy":{"Id":"df261e23-cbeb-40cf-8474-2e9fd18e5448","Name":"System Admin"},"ModifiedDate":"2023-09-29T12:02:45.0362162+00:00","ExternalId":"12b80136-4d4b-4aec-96ed-fa75b74a4694","ETag":null},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"delete": {
"tags": [
"Object Permission"
],
"summary": "Delete an object permission",
"description": "Removes an object permission and returns the deleted object permission's ID.",
"parameters": [
{
"name": "objectPermissionId",
"in": "path",
"description": "Object permission ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"4f64ee28-3484-4467-b1d9-10d2030f99fc deleted successfully.","StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/objectpermissions/{objectName}/actionpermissions/{actionName}/validate": {
"get": {
"tags": [
"Object Permission"
],
"summary": "Validate object action permission",
"description": "Based on the object name and action name, validates whether the object has action permission.",
"parameters": [
{
"name": "objectName",
"in": "path",
"description": "Object name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "actionName",
"in": "path",
"description": "Action name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanNullableAPIResponse"
},
"example": {"Success":true,"Data":true,"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/objectpermissions/objects/{objectName}": {
"get": {
"tags": [
"Object Permission"
],
"summary": "Get object permission details by object name",
"description": "Fetches the object permission details for the provided object name.",
"parameters": [
{
"name": "objectName",
"in": "path",
"description": "Object name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectPermissionListAPIResponse"
},
"example": {"Success":true,"Data":{"ObjectName":"SampleObjectName","PermissionGroupName":"SamplePermissionGroupName","ViewAll":true,"ModifyAll":false,"ActionPermissions":"{\"CREATE\":{\"Standard\":true,\"Enabled\":true,\"Criteria\":\"\"},\"UPDATE\":{\"Standard\":true,\"Enabled\":true,\"Criteria\":\"\"},\"DELETE\":{\"Standard\":true,\"Enabled\":false,\"Criteria\":\"\"},\"READ\":{\"Standard\":true,\"Enabled\":true,\"Criteria\":\"\"}}","ScopePermissions":"{\"GLOBAL\":\"\",\"USER\":[],\"ACCOUNT\":null,\"CONTACT\":\"\"}","IsDeleted":false,"Id":"3c4b4426-b933-4177-ad4b-03846f06c58b","Name":"SampleObjectName.SamplePermissionGroupName","CreatedBy":{"Id":"80a23d94-453f-41b5-b2b5-c47708fd7341","Name":"System Admin"},"CreatedDate":"2023-09-29T12:02:45.0399196+00:00","ModifiedBy":{"Id":"46c5a040-47e2-4aa8-85a1-14707a548bc2","Name":"System Admin"},"ModifiedDate":"2023-09-29T12:02:45.0399206+00:00","ExternalId":"699fe07f-27a7-434d-a021-85bfaf19b9e0","ETag":null},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/actionpermissions": {
"get": {
"tags": [
"Action Permissions"
],
"summary": "Get all action permissions",
"description": "Retrieves the master list of action permissions from the data storage.",
"responses": {
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionPermissionsGroupAPIResponse"
},
"example": {"Success":true,"Data":{"ActionPermissionsList":[{"DisplayName":"Action Permission","Value":"ACTION_PERMISSION"}]},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/user/info": {
"get": {
"tags": [
"User"
],
"summary": "Get logged-in user information",
"description": "Returns information about the current logged-in user.<p>**Note**: If the locale, currency, and time zone information are not available at the user level, this endpoint retrieves them from the organization level.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponseAPIResponse"
},
"example": {"Success":true,"Data":{"FirstName":"system","LastName":"user","UserName":"SystemUser","Email":"systemuser@conga.com","Role":{"Id":"6b9d6259-ccf1-47c7-9a17-e806dc5b9227","Name":"SysAdmin"},"PermissionGroups":"ScopePermissionGroup","RolePermissionGroups":null,"Timezone":null,"Locale":null,"Currency":null,"CurrencyFormat":null,"IsDeleted":false,"IsActive":true,"IsSuspended":null,"Alias":null,"Language":null,"SmallPhotoUrl":null,"LastLoginDate":null,"Address":"71 ST. NICHOLAS DRIVE","PhoneNumber":null,"IdentityStatus":null,"UserType":"External","AdminPermissions":null,"Id":null,"Name":null,"CreatedBy":{"Id":"c69ac1f3-2023-4ec2-ad9e-3a5274ce439a","Name":"System Admin"},"CreatedDate":"2023-09-29T12:02:45.0426237+00:00","ModifiedBy":{"Id":"35ce6158-952d-49c2-a25f-ab3b109b73f7","Name":"System Admin"},"ModifiedDate":"2023-09-29T12:02:45.0426246+00:00","ExternalId":null,"ETag":null},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/user/locale": {
"get": {
"tags": [
"User"
],
"summary": "Get logged-in user's locale information",
"description": "Returns the locale information for the current logged-in user.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocaleAPIResponse"
},
"example": {"Success":true,"Data":{"DisplayName":"English (United States)","Name":"en-US","NumberFormat":{"DecimalSymbol":".","DigitGroup":"123,456,789.00","DigitGroupingSymbol":",","NegativeNumberFormat":"- n"},"DateFormat":{"LongDateFormat":"dddd, MMMM d, yyyy","ShortDateFormat":"M/d/yyyy","TimeFormat":"h:mm tt"}},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/user/timezone": {
"get": {
"tags": [
"User"
],
"summary": "Get logged-in user's timezone information",
"description": "Returns time zone information for the current logged-in user.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimezoneAPIResponse"
},
"example": {"Success":true,"Data":{"TimezoneName":"(GMT) UTC (UTC)","TimezoneId":"UTC","TimezoneAlternateId":"UTC"},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/user/currency": {
"get": {
"tags": [
"User"
],
"summary": "Get logged-in user's currency information",
"description": "Returns currency information for the current logged-in user.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringAPIResponse"
},
"example": {"Success":true,"Data":"USD","StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/user/currency-format": {
"get": {
"tags": [
"User"
],
"summary": "Get logged-in user's currency format information",
"description": "Returns currency format information for the current logged-in user.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurrencyFormatAPIResponse"
},
"example": {"Success":true,"Data":{"PositiveCurrencyFormat":"$n","NegativeCurrencyFormat":"-$n"},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/user/actionpermissions": {
"get": {
"tags": [
"User"
],
"summary": "Get all action permissions",
"description": "Retrieves the details of all object action permissions.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringStringBooleanDictionaryDictionaryAPIResponse"
}
}
}
}
}
}
},
"/api/user-management/v1/timezones": {
"get": {
"tags": [
"Timezone and Locale"
],
"summary": "Get all time zones",
"description": "Retrieves all time zones.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimezoneResponseListAPIResponse"
},
"example": {"Success":true,"Data":[{"TimezoneName":"(GMT-11:00) UTC-11 (Pacific/Midway)","TimezoneId":"Pacific/Midway"},{"TimezoneName":"(GMT-11:00) UTC-11 (Pacific/Niue)","TimezoneId":"Pacific/Niue"},{"TimezoneName":"(GMT-11:00) UTC-11 (Pacific/Pago_Pago)","TimezoneId":"Pacific/Pago_Pago"},{"TimezoneName":"(GMT-10:00) Hawaiian Standard Time (Pacific/Rarotonga)","TimezoneId":"Pacific/Rarotonga"},{"TimezoneName":"(GMT-10:00) Aleutian Standard Time (America/Adak)","TimezoneId":"America/Adak"}],"StatusCode":"OK"}
}
}
}
}
}
},
"/api/user-management/v1/locales": {
"get": {
"tags": [
"Timezone and Locale"
],
"summary": "Get all locales",
"description": "Retrieves all locales.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocaleResponseListAPIResponse"
},
"example": {"Success":true,"Data":[{"Name":"es-ES","DisplayName":"Spanish (Spain)"},{"Name":"de-DE","DisplayName":"German (Germany)"},{"Name":"fr-FR","DisplayName":"French (France)"}],"StatusCode":"OK"}
}
}
}
}
}
},
"/api/user-management/v1/decimal-symbols": {
"get": {
"tags": [
"Timezone and Locale"
],
"summary": "Get all decimal symbols from locales",
"description": "Retrieves all decimal symbols from locales.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DecimalSymbolsAPIResponse"
},
"example": {"Success":true,"Data":{"DecimalSymbolsList":[{"DisplayValue":".","Value":"."}]},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/digitgrouping-symbols": {
"get": {
"tags": [
"Timezone and Locale"
],
"summary": "Get all digit grouping symbols from locales",
"description": "Retrieves all digit grouping symbols from locales.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DigitGroupingSymbolAPIResponse"
},
"example": {"Success":true,"Data":{"DigitGroupingSymbols":[{"DisplayValue":",","Value":","}]},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/longdate-formats": {
"get": {
"tags": [
"Timezone and Locale"
],
"summary": "Get all long date formats from locales",
"description": "Retrieves all long date formats from locales.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LongDateFormatAPIResponse"
},
"example": {"Success":true,"Data":{"LongDateFormatList":[{"DisplayValue":"dddd, MMMM dd, yyyy","Value":"dddd, MMMM dd, yyyy"}]},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/shortdate-formats": {
"get": {
"tags": [
"Timezone and Locale"
],
"summary": "Get all short date formats from locales",
"description": "Retrieves all short date formats from locales.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShortDateFormatAPIResponse"
},
"example": {"Success":true,"Data":{"ShortDateFormatList":[{"DisplayValue":"dd/MM/yyyy","Value":"dd/MM/yyyy"}]},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/time-formats": {
"get": {
"tags": [
"Timezone and Locale"
],
"summary": "Get all time formats from locales",
"description": "Retrieves all time formats from locales.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimeFormatAPIResponse"
},
"example": {"Success":true,"Data":{"TimeFormatList":[{"DisplayValue":"h:mm tt","Value":"h:mm tt"}]},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/digitgroups": {
"get": {
"tags": [
"Timezone and Locale"
],
"summary": "Get all digit groups from locales",
"description": "Retrieves all digit groups from locales.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DigitGroupAPIResponse"
},
"example": {"Success":true,"Data":{"DigitGroupList":[{"DisplayValue":"123,456,789.00","Value":"123,456,789.00"}]},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/negativenumber-formats": {
"get": {
"tags": [
"Timezone and Locale"
],
"summary": "Get all negative number formats from locales",
"description": "Retrieves all negative number formats from locales.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NegativeNumberFormatAPIResponse"
},
"example": {"Success":true,"Data":{"NegativeNumberFormatList":[{"DisplayValue":"-n","Value":"-n"}]},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/api/user-management/v1/currency-formats": {
"get": {
"tags": [
"Currency Format"
],
"summary": "Get all currency formats",
"description": "Retrieves all currency formats based on the provided format type.",
"parameters": [
{
"name": "formatType",
"in": "query",
"description": "Provides format type as *PositiveCurrencyFormat* or *NegativeCurrencyFormat*.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PositiveCurrencyFormatAPIResponse"
},
"example": {"Success":true,"Data":{"CurrencyFormatList":[{"DisplayValue":"$n","Value":"$n"},{"DisplayValue":"n $","Value":"n $"}]},"StatusCode":"OK"}
}
}
},
"404": {
"description": "Not Found"
}
}
}
}
},
"components": {
"schemas": {
"APIConnection": {
"type": "object",
"properties": {
"APIType": {
"type": "string",
"nullable": true
},
"ClientId": {
"type": "string",
"nullable": true
},
"ClientName": {
"type": "string",
"nullable": true
},
"Description": {
"type": "string",
"nullable": true
},
"IsActive": {
"type": "boolean"
},
"ExternalIdentifier": {
"type": "string",
"nullable": true
},
"CorsOrigins": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"BackChannelLogoutURI": {
"type": "string",
"nullable": true
},
"FrontChannelLogoutURI": {
"type": "string",
"nullable": true
},
"RedirectURI": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"ClientSecret": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"APIConnectionAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/APIConnection"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"APIConnectionCreateRequest": {
"type": "object",
"properties": {
"Description": {
"type": "string",
"description": "The API connection's description",
"nullable": true
},
"ClientName": {
"type": "string",
"description": "The client's name",
"nullable": true
},
"CorsOrigins": {
"type": "array",
"items": {
"type": "string"
},
"description": "URI for Cross-Origin Resource Sharing (CORS)",
"nullable": true
},
"BackChannelLogoutURI": {
"type": "string",
"description": "URI for direct back-channel communication between the OpenID Providers(OP) and Relying Party(RP) being logged out",
"nullable": true
},
"FrontChannelLogoutURI": {
"type": "string",
"description": "URI to communicate logout requests from the OpenID Providers(OP) to Relying Party(RP) via the User Agent",
"nullable": true
},
"RedirectURI": {
"type": "array",
"items": {
"type": "string"
},
"description": "Redirects the request to the defined URL",
"nullable": true
}
},
"additionalProperties": false
},
"APIConnectionListAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIConnection"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"APIConnectionType": {
"enum": [
"APItoAPI",
"UItoAPI"
],
"type": "string"
},
"ActionPermissionConfig": {
"type": "object",
"properties": {
"ActionName": {
"type": "string",
"nullable": true
},
"Enabled": {
"type": "boolean"
},
"Criteria": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ActionPermissionValues": {
"type": "object",
"properties": {
"DisplayName": {
"type": "string",
"nullable": true
},
"Value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ActionPermissionsGroup": {
"type": "object",
"properties": {
"ActionPermissionsList": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/ActionPermissionValues"
},
"nullable": true
}
},
"additionalProperties": false
},
"ActionPermissionsGroupAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/ActionPermissionsGroup"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"AdminPermissions": {
"type": "object",
"properties": {
"AdminPermissionsList": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/AdminPermissionsValues"
},
"nullable": true
}
},
"additionalProperties": false
},
"AdminPermissionsAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/AdminPermissions"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"AdminPermissionsValues": {
"type": "object",
"properties": {
"Value": {
"type": "string",
"nullable": true
},
"DisplayName": {
"type": "string",
"nullable": true
},
"Description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AssignAdminPermissions": {
"type": "object",
"properties": {
"AdminPermissionNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of admin permission names to be assigned for the role.",
"nullable": true
}
},
"additionalProperties": false
},
"AssignPermissionGroups": {
"type": "object",
"properties": {
"PermissionGroupNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of permission group names to be assigned for the role.",
"nullable": true
}
},
"additionalProperties": false
},
"BooleanNullableAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"type": "boolean",
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"BulkUserUpdateRequest": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"nullable": true
},
"FirstName": {
"type": "string",
"nullable": true
},
"LastName": {
"type": "string",
"nullable": true
},
"Email": {
"type": "string",
"nullable": true
},
"Role": {
"$ref": "#/components/schemas/LookupObject"
},
"Timezone": {
"type": "string",
"nullable": true
},
"LocaleName": {
"type": "string",
"nullable": true
},
"LocaleDecimalSymbol": {
"type": "string",
"nullable": true
},
"LocaleDigitGroup": {
"type": "string",
"nullable": true
},
"LocaleDigitGroupingSymbol": {
"type": "string",
"nullable": true
},
"LocaleNegativeNumberFormat": {
"type": "string",
"nullable": true
},
"LocaleLongDateFormat": {
"type": "string",
"nullable": true
},
"LocaleShortDateFormat": {
"type": "string",
"nullable": true
},
"LocaleTimeFormat": {
"type": "string",
"nullable": true
},
"Currency": {
"type": "string",
"nullable": true
},
"CurrencyFormat": {
"type": "string",
"nullable": true
},
"IsSuspended": {
"type": "boolean",
"nullable": true
},
"Alias": {
"type": "string",
"nullable": true
},
"Language": {
"type": "string",
"nullable": true
},
"Address": {
"type": "string",
"nullable": true
},
"PhoneNumber": {
"type": "string",
"nullable": true
},
"ExternalId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CurrencyFormat": {
"type": "object",
"properties": {
"PositiveCurrencyFormat": {
"type": "string",
"nullable": true
},
"NegativeCurrencyFormat": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CurrencyFormatAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/CurrencyFormat"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"DateFormat": {
"type": "object",
"properties": {
"LongDateFormat": {
"type": "string",
"nullable": true
},
"ShortDateFormat": {
"type": "string",
"nullable": true
},
"TimeFormat": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DecimalSymbols": {
"type": "object",
"properties": {
"DecimalSymbolsList": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/LocaleFieldValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"DecimalSymbolsAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/DecimalSymbols"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"DeleteAdminPermissions": {
"type": "object",
"properties": {
"AdminPermissionNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"DeletePermissionGroups": {
"type": "object",
"properties": {
"PermissionGroupNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "Collection of the PermissionGroupNames to be Deleted",
"nullable": true
}
},
"additionalProperties": false
},
"DigitGroup": {
"type": "object",
"properties": {
"DigitGroupList": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/LocaleFieldValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"DigitGroupAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/DigitGroup"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"DigitGroupingSymbol": {
"type": "object",
"properties": {
"DigitGroupingSymbols": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/LocaleFieldValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"DigitGroupingSymbolAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/DigitGroupingSymbol"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"ErrorDetail": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ExternalIntegrationIdentifierCreateRequest": {
"type": "object",
"properties": {
"ExternalId": {
"type": "string",
"description": "Unique record identifiers from the external system",
"nullable": true
},
"Type": {
"type": "string",
"description": "Type of the external system",
"nullable": true
},
"Description": {
"type": "string",
"description": "Description of the external integration identifier",
"nullable": true
}
},
"additionalProperties": false
},
"GuestUserCreateRequest": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "The guest user's ID",
"nullable": true
},
"FirstName": {
"type": "string",
"description": "The guest user's first name",
"nullable": true
},
"LastName": {
"type": "string",
"description": "The guest user's last name",
"nullable": true
},
"Email": {
"type": "string",
"description": "The guest user's email address",
"nullable": true
},
"Timezone": {
"type": "string",
"description": "The guest user's time zone",
"nullable": true
},
"Locale": {
"type": "string",
"description": "The guest user's locale",
"nullable": true
},
"Currency": {
"type": "string",
"description": "The guest user's currency",
"nullable": true
},
"Alias": {
"type": "string",
"description": "The guest user's alias name",
"nullable": true
},
"Language": {
"type": "string",
"description": "The guest user's language",
"nullable": true
},
"Address": {
"type": "string",
"description": "The guest user's address",
"nullable": true
},
"PhoneNumber": {
"type": "string",
"description": "The guest user's phone number",
"nullable": true
}
},
"additionalProperties": false
},
"GuestUserUpdateRequest": {
"type": "object",
"properties": {
"FirstName": {
"type": "string",
"description": "The guest user's first name",
"nullable": true
},
"LastName": {
"type": "string",
"description": "The guest user's last name",
"nullable": true
},
"Email": {
"type": "string",
"description": "The guest user's email address",
"nullable": true
},
"Timezone": {
"type": "string",
"description": "The guest user's time zone",
"nullable": true
},
"Locale": {
"type": "string",
"description": "The guest user's locale",
"nullable": true
},
"Currency": {
"type": "string",
"description": "The guest user's currency",
"nullable": true
},
"Alias": {
"type": "string",
"description": "The guest user's alias name",
"nullable": true
},
"Language": {
"type": "string",
"description": "The guest user's language",
"nullable": true
},
"Address": {
"type": "string",
"description": "The guest user's address",
"nullable": true
},
"PhoneNumber": {
"type": "string",
"description": "The guest user's phone number",
"nullable": true
}
},
"additionalProperties": false
},
"HttpStatusCode": {
"enum": [
"Continue",
"SwitchingProtocols",
"Processing",
"EarlyHints",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultiStatus",
"AlreadyReported",
"IMUsed",
"MultipleChoices",
"MovedPermanently",
"Found",
"SeeOther",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"PermanentRedirect",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"MisdirectedRequest",
"UnprocessableEntity",
"Locked",
"FailedDependency",
"UpgradeRequired",
"PreconditionRequired",
"TooManyRequests",
"RequestHeaderFieldsTooLarge",
"UnavailableForLegalReasons",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported",
"VariantAlsoNegotiates",
"InsufficientStorage",
"LoopDetected",
"NotExtended",
"NetworkAuthenticationRequired"
],
"type": "string"
},
"IDPMaster": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"nullable": true
},
"ACRName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"IDPMasterListAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IDPMaster"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"Locale": {
"type": "object",
"properties": {
"DisplayName": {
"type": "string",
"nullable": true
},
"Name": {
"type": "string",
"nullable": true
},
"NumberFormat": {
"$ref": "#/components/schemas/NumberFormat"
},
"DateFormat": {
"$ref": "#/components/schemas/DateFormat"
}
},
"additionalProperties": false
},
"LocaleAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/Locale"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"LocaleFieldValue": {
"type": "object",
"properties": {
"DisplayValue": {
"type": "string",
"nullable": true
},
"Value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"LocaleResponse": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Name of the Locale",
"nullable": true
},
"DisplayName": {
"type": "string",
"description": "DisplayName of the Locale",
"nullable": true
}
},
"additionalProperties": false
},
"LocaleResponseListAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LocaleResponse"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"LongDateFormat": {
"type": "object",
"properties": {
"LongDateFormatList": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/LocaleFieldValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"LongDateFormatAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/LongDateFormat"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"LookupObject": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"nullable": true
},
"Name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"NegativeNumberFormat": {
"type": "object",
"properties": {
"NegativeNumberFormatList": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/LocaleFieldValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"NegativeNumberFormatAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/NegativeNumberFormat"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"NumberFormat": {
"type": "object",
"properties": {
"DecimalSymbol": {
"type": "string",
"nullable": true
},
"DigitGroup": {
"type": "string",
"nullable": true
},
"DigitGroupingSymbol": {
"type": "string",
"nullable": true
},
"NegativeNumberFormat": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ObjectPermission": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"nullable": true
},
"Name": {
"type": "string",
"nullable": true
},
"CreatedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ExternalId": {
"type": "string",
"nullable": true
},
"ETag": {
"type": "string",
"nullable": true
},
"ObjectName": {
"type": "string",
"nullable": true
},
"PermissionGroupName": {
"type": "string",
"nullable": true
},
"ViewAll": {
"type": "boolean"
},
"ModifyAll": {
"type": "boolean"
},
"ActionPermissions": {
"nullable": true
},
"ScopePermissions": {
"nullable": true
},
"IsDeleted": {
"type": "boolean"
}
},
"additionalProperties": { }
},
"ObjectPermissionAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/ObjectPermission"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"ObjectPermissionCreateRequest": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"nullable": true
},
"ObjectName": {
"type": "string",
"nullable": true
},
"PermissionGroupName": {
"type": "string",
"nullable": true
},
"ViewAll": {
"type": "boolean"
},
"ModifyAll": {
"type": "boolean"
},
"ActionPermissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActionPermissionConfig"
},
"nullable": true
},
"ScopePermissions": {
"$ref": "#/components/schemas/ScopePermissionConfig"
},
"ExternalId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ObjectPermissionListAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectPermission"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"ObjectPermissionUpdateRequest": {
"type": "object",
"properties": {
"ObjectName": {
"type": "string",
"description": "Object name for which object permission is to be updated",
"nullable": true
},
"PermissionGroupName": {
"type": "string",
"description": "Permission group name for which object permission is to be updated",
"nullable": true
},
"ViewAll": {
"type": "boolean",
"description": "Provides view access to all the defined resources"
},
"ModifyAll": {
"type": "boolean",
"description": "Provides view and modify access to all the defined resources"
},
"ActionPermissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActionPermissionConfig"
},
"description": "Collection of action permissions",
"nullable": true
},
"ScopePermissions": {
"$ref": "#/components/schemas/ScopePermissionConfig"
},
"ExternalId": {
"type": "string",
"description": "ExternalId",
"nullable": true
}
},
"additionalProperties": false
},
"OrganizationExternalIntegrationCreateRequest": {
"type": "object",
"properties": {
"ExternalIntegrationIdentifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalIntegrationIdentifierCreateRequest"
},
"description": "Unique record ID of the external system",
"nullable": true
}
},
"additionalProperties": false
},
"OrganizationUpdateRequest": {
"type": "object",
"properties": {
"Currency": {
"type": "string",
"description": "The organization's currency",
"nullable": true
},
"PositiveCurrencyFormat": {
"type": "string",
"description": "Positive Currency Format of the Organization",
"nullable": true
},
"NegativeCurrencyFormat": {
"type": "string",
"description": "Negative Currency Format of the Organization",
"nullable": true
},
"TimezoneId": {
"type": "string",
"description": "The organization's time zone ID",
"nullable": true
},
"LocaleName": {
"type": "string",
"description": "The organization's locale name",
"nullable": true
},
"LocaleDecimalSymbol": {
"type": "string",
"description": "The organization's decimal symbol",
"nullable": true
},
"LocaleDigitGroup": {
"type": "string",
"description": "The organization's digit group",
"nullable": true
},
"LocaleDigitGroupingSymbol": {
"type": "string",
"description": "The organization's digit grouping symbol",
"nullable": true
},
"LocaleNegativeNumberFormat": {
"type": "string",
"description": "The organization's negative number format",
"nullable": true
},
"LocaleLongDateFormat": {
"type": "string",
"description": "The organization's long date format",
"nullable": true
},
"LocaleShortDateFormat": {
"type": "string",
"description": "The organization's short date format",
"nullable": true
},
"LocaleTimeFormat": {
"type": "string",
"description": "The organization's time format",
"nullable": true
},
"PhoneNumber": {
"type": "string",
"description": "The organization's phone number",
"nullable": true
},
"Address": {
"type": "string",
"description": "The organization's address",
"nullable": true
},
"IsActive": {
"type": "boolean",
"description": "Indicates whether the organization is active or not",
"nullable": true
},
"AutoProvisionUserEnabled": {
"type": "boolean",
"description": "Allows user to auto provision to Conga Platform",
"nullable": true
},
"OrganizationDisplayName": {
"type": "string",
"description": "The organization's display name",
"nullable": true
}
},
"additionalProperties": false
},
"PermissionGroupValue": {
"type": "object",
"properties": {
"DisplayValue": {
"type": "string",
"nullable": true
},
"Value": {
"type": "string",
"nullable": true
},
"Description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PermissionGroups": {
"type": "object",
"properties": {
"PermissionGroupNamesList": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionGroupValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"PermissionGroupsAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/PermissionGroups"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"PermissionGroupsCreateRequest": {
"type": "object",
"properties": {
"PermissionGroupNamesList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionGroupValue"
},
"description": "Collection of permission group names",
"nullable": true
}
},
"additionalProperties": false
},
"PermissionGroupsDeleteRequest": {
"type": "object",
"properties": {
"PermissionGroupNamesList": {
"type": "array",
"items": {
"type": "string"
},
"description": "Collection of the permission group names to be deleted",
"nullable": true
}
},
"additionalProperties": false
},
"PositiveCurrencyFormat": {
"type": "object",
"properties": {
"CurrencyFormatList": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/LocaleFieldValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"PositiveCurrencyFormatAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/PositiveCurrencyFormat"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"Role": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"nullable": true
},
"Name": {
"type": "string",
"nullable": true
},
"CreatedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ExternalId": {
"type": "string",
"nullable": true
},
"ETag": {
"type": "string",
"nullable": true
},
"Description": {
"type": "string",
"nullable": true
},
"PermissionGroups": {
"type": "string",
"nullable": true
},
"IsDeleted": {
"type": "boolean"
},
"AdminPermissions": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"RoleAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/Role"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"RoleCloneRequest": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "The role's name",
"nullable": true
},
"CopyPermissionGroups": {
"type": "boolean",
"description": "Indicates whether to clone permission groups from the role."
}
},
"additionalProperties": false
},
"RoleCreateRequest": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "The role's ID",
"nullable": true
},
"Name": {
"type": "string",
"description": "The role's name",
"nullable": true
},
"Description": {
"type": "string",
"description": "The role's description",
"nullable": true
},
"PermissionGroups": {
"type": "string",
"description": "Permission groups to assign for the role",
"nullable": true
},
"ExternalId": {
"type": "string",
"description": "ExternalId",
"nullable": true
},
"AdminPermissions": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RoleUpdateRequest": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "The role's name",
"nullable": true
},
"Description": {
"type": "string",
"description": "The role's description",
"nullable": true
}
},
"additionalProperties": false
},
"ScopePermissionConfig": {
"type": "object",
"properties": {
"GLOBAL": {
"type": "string",
"nullable": true
},
"USER": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserScopeConfig"
},
"nullable": true
},
"ACCOUNT": {
"type": "string",
"nullable": true
},
"CONTACT": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ShortDateFormat": {
"type": "object",
"properties": {
"ShortDateFormatList": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/LocaleFieldValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"ShortDateFormatAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/ShortDateFormat"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"StringAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"type": "string",
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"StringListAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"StringObjectDictionaryListAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": { }
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"StringStringBooleanDictionaryDictionaryAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"TimeFormat": {
"type": "object",
"properties": {
"TimeFormatList": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/LocaleFieldValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"TimeFormatAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/TimeFormat"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"Timezone": {
"type": "object",
"properties": {
"TimezoneName": {
"type": "string",
"nullable": true
},
"TimezoneId": {
"type": "string",
"nullable": true
},
"TimezoneAlternateId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TimezoneAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/Timezone"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"TimezoneResponse": {
"type": "object",
"properties": {
"TimezoneName": {
"type": "string",
"description": "Name of the Timezone",
"nullable": true
},
"TimezoneId": {
"type": "string",
"description": "Id of the Timezone",
"nullable": true
}
},
"additionalProperties": false
},
"TimezoneResponseListAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimezoneResponse"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateAPIConnectionStatusRequest": {
"type": "object",
"properties": {
"IsActive": {
"type": "boolean",
"description": "Indicates whether the status of API connection is active or not."
}
},
"additionalProperties": false
},
"UserCloneRequest": {
"type": "object",
"properties": {
"ExternalId": {
"type": "string",
"description": "ExternalId of the user to be cloned",
"nullable": true
},
"Email": {
"type": "string",
"description": "Email of the user to be cloned",
"nullable": true
}
},
"additionalProperties": false
},
"UserCreateRequest": {
"type": "object",
"properties": {
"FirstName": {
"type": "string",
"description": "The user's first name",
"nullable": true
},
"LastName": {
"type": "string",
"description": "The user's last name",
"nullable": true
},
"Email": {
"type": "string",
"description": "The user's email address",
"nullable": true
},
"Timezone": {
"type": "string",
"description": "The user's time zone",
"nullable": true
},
"Locale": {
"type": "string",
"description": "The user's locale",
"nullable": true
},
"Currency": {
"type": "string",
"description": "The user's currency",
"nullable": true
},
"ExternalId": {
"type": "string",
"description": "The user's external ID",
"nullable": true
},
"Alias": {
"type": "string",
"description": "The user's alias name",
"nullable": true
},
"Language": {
"type": "string",
"description": "The user's language",
"nullable": true
},
"Address": {
"type": "string",
"description": "The user's address",
"nullable": true
},
"PhoneNumber": {
"type": "string",
"description": "The user's phone number",
"nullable": true
},
"Role": {
"$ref": "#/components/schemas/LookupObject"
}
},
"additionalProperties": false
},
"UserResponse": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"nullable": true
},
"Name": {
"type": "string",
"nullable": true
},
"CreatedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"CreatedDate": {
"type": "string",
"format": "date-time"
},
"ModifiedBy": {
"$ref": "#/components/schemas/LookupObject"
},
"ModifiedDate": {
"type": "string",
"format": "date-time"
},
"ExternalId": {
"type": "string",
"nullable": true
},
"ETag": {
"type": "string",
"nullable": true
},
"FirstName": {
"type": "string",
"description": "FirstName of the User",
"nullable": true
},
"LastName": {
"type": "string",
"description": "LastName of the User",
"nullable": true
},
"UserName": {
"type": "string",
"description": "UserName of the User",
"nullable": true
},
"Email": {
"type": "string",
"description": "Email of the User",
"nullable": true
},
"Role": {
"$ref": "#/components/schemas/LookupObject"
},
"PermissionGroups": {
"type": "string",
"description": "PermissionGroups assigned to the user",
"nullable": true
},
"RolePermissionGroups": {
"type": "string",
"description": "RolePermissionGroups assigned to the user",
"nullable": true
},
"Timezone": {
"type": "string",
"description": "Timezone of the User",
"nullable": true
},
"Locale": {
"type": "string",
"description": "Locale of the User",
"nullable": true
},
"Currency": {
"type": "string",
"description": "Currency of the User",
"nullable": true
},
"CurrencyFormat": {
"type": "string",
"description": "Currency Format of the User",
"nullable": true
},
"IsDeleted": {
"type": "boolean",
"description": "Indicates whether the user is Deleted or not"
},
"IsActive": {
"type": "boolean",
"description": "Indicates whether the user is Active or not"
},
"IsSuspended": {
"type": "boolean",
"description": "Indicates whether the user is Suspended or not",
"nullable": true
},
"Alias": {
"type": "string",
"description": "Alias Name of the User",
"nullable": true
},
"Language": {
"type": "string",
"description": "Language of the User",
"nullable": true
},
"SmallPhotoUrl": {
"type": "string",
"description": "SmallPhotoUrl of the User",
"nullable": true
},
"LastLoginDate": {
"type": "string",
"description": "LastLoginDate of the User",
"format": "date-time",
"nullable": true
},
"Address": {
"type": "string",
"description": "Address of the User",
"nullable": true
},
"PhoneNumber": {
"type": "string",
"description": "PhoneNumber of the User",
"nullable": true
},
"IdentityStatus": {
"type": "string",
"description": "IdentityStatus of the User",
"nullable": true
},
"UserType": {
"$ref": "#/components/schemas/UserType"
},
"AdminPermissions": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"UserResponseAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/UserResponse"
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"UserResponseListAPIResponse": {
"type": "object",
"properties": {
"Success": {
"type": "boolean"
},
"RecordCount": {
"type": "integer",
"format": "int64",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResponse"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
},
"nullable": true
},
"Profile": {
"type": "string",
"nullable": true
},
"TotalTime": {
"type": "number",
"format": "float"
},
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"HasMoreRecords": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"UserScopeConfig": {
"type": "object",
"properties": {
"RelationshipFieldName": {
"type": "string",
"nullable": true
},
"Criteria": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UserType": {
"enum": [
"External",
"Guest"
],
"type": "string"
},
"UserUpdateRequest": {
"type": "object",
"properties": {
"FirstName": {
"type": "string",
"description": "The user's first name",
"nullable": true
},
"LastName": {
"type": "string",
"description": "The user's last name",
"nullable": true
},
"Email": {
"type": "string",
"description": "The user's email address",
"nullable": true
},
"Role": {
"$ref": "#/components/schemas/LookupObject"
},
"Timezone": {
"type": "string",
"description": "The user's time zone",
"nullable": true
},
"LocaleName": {
"type": "string",
"description": "The user's locale",
"nullable": true
},
"LocaleDecimalSymbol": {
"type": "string",
"description": "The user's decimal symbol",
"nullable": true
},
"LocaleDigitGroup": {
"type": "string",
"description": "The user's digit group",
"nullable": true
},
"LocaleDigitGroupingSymbol": {
"type": "string",
"description": "The user's digit grouping symbol",
"nullable": true
},
"LocaleNegativeNumberFormat": {
"type": "string",
"description": "The user's negative number format",
"nullable": true
},
"LocaleLongDateFormat": {
"type": "string",
"description": "The user's long date format",
"nullable": true
},
"LocaleShortDateFormat": {
"type": "string",
"description": "The user's short date format",
"nullable": true
},
"LocaleTimeFormat": {
"type": "string",
"description": "The user's time format",
"nullable": true
},
"Currency": {
"type": "string",
"description": "The user's currency",
"nullable": true
},
"PositiveCurrencyFormat": {
"type": "string",
"description": "The user's positive currency format",
"nullable": true
},
"NegativeCurrencyFormat": {
"type": "string",
"description": "The user's negative currency format",
"nullable": true
},
"IsSuspended": {
"type": "boolean",
"description": "Indicates whether the user is suspended or not",
"nullable": true
},
"Alias": {
"type": "string",
"description": "The user's alias name",
"nullable": true
},
"Language": {
"type": "string",
"description": "The user's language",
"nullable": true
},
"Address": {
"type": "string",
"description": "The user's address",
"nullable": true
},
"PhoneNumber": {
"type": "string",
"description": "The user's phone number",
"nullable": true
},
"ExternalId": {
"type": "string",
"description": "The user's ExternalId",
"nullable": true
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Please insert JWT with Bearer into field",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}