Auto Client Mapping

An Object

Table of Contents
Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Parent

This Auto Client Mapping is contained within a Web Host.

Properties

The following properties are available:

Property Type Default Read-Only Description
_doc string No The primary ID
_system object No Metadata maintained by the system
applicationId string No
applicationKey string No
automanage boolean No
clientKey string No
tenantId string No
uri string No

Methods

The following methods are available:

Check Permission

Checks whether one or more authorities against the specified autoClientMapping are granted for a given set of users
POST /webhosts/{webhostId}/autoclientmappings/{autoClientMappingId}/permissions/{permissionId}/check

Parameters

Name Required Type Description
webhostId true string The ID of the web host
autoClientMappingId true string
permissionId true string The ID of the permission
id true string

Response

{
  "$ref": "#/components/schemas/checkPermission"
}

Check Single Authority

Checks whether a single authority is granted against the specified autoClientMapping for the given user
POST /webhosts/{webhostId}/autoclientmappings/{autoClientMappingId}/authorities/{authorityId}/check

Parameters

Name Required Type Description
webhostId true string The ID of the web host
autoClientMappingId true string
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "check": {
      "type": "boolean"
    },
    "ok": null
  }
}

Check multiple Authorities

Checks whether one or more authorities against the specified autoClientMapping are granted for a given set of users
POST /webhosts/{webhostId}/autoclientmappings/authorities/check

Parameters

Name Required Type Description
webhostId true string The ID of the web host

Response

{
  "type": "object",
  "description": "Check Multiple Authorities Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "authorityId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Check multiple Permissions

Checks whether one or more permissions against the specified autoClientMapping are granted for a given set of users
POST /webhosts/{webhostId}/autoclientmappings/permissions/check

Parameters

Name Required Type Description
webhostId true string The ID of the web host

Response

{
  "type": "object",
  "description": "Check Multiple Permissions Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "permissionId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Create Auto Client Mapping

Creates a new Auto Client Mapping
POST /webhosts/{webhostId}/autoclientmappings

Parameters

Name Required Type Description
webhostId true string The ID of the web host

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Auto Client Mapping

Deletes an existing Auto Client Mapping
DELETE /webhosts/{webhostId}/autoclientmappings/{autoClientMappingId}

Parameters

Name Required Type Description
webhostId true string The ID of the web host
autoClientMappingId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Auto Client Mapping

Deletes an existing Auto Client Mapping
POST /webhosts/{webhostId}/autoclientmappings/{autoClientMappingId}/delete

Parameters

Name Required Type Description
webhostId true string The ID of the web host
autoClientMappingId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Grant Authority

Grants an authority against the specified autoClientMapping to a given user
POST /webhosts/{webhostId}/autoclientmappings/{autoClientMappingId}/authorities/{authorityId}/grant

Parameters

Name Required Type Description
webhostId true string The ID of the web host
autoClientMappingId true string
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Lists Auto Client Mapping

Retrieves a list of Auto Client Mapping instances
GET /webhosts/{webhostId}/autoclientmappings

Parameters

Name Required Type Description
webhostId true string The ID of the web host
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set
This method supports pagination.

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_autoClientMapping"
      }
    }
  }
}

Lists the auto client mappings for an application

Lists the auto client mappings for an application
GET /applications/{applicationId}/autoclientmappings

Parameters

Name Required Type Description
applicationId true string The ID of the application
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set
This method supports pagination.

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_autoClientMapping"
      }
    }
  }
}

Lists the auto client mappings for an application

Lists the auto client mappings for an application
GET /applications/{applicationId}/autoclientmappings/

Parameters

Name Required Type Description
applicationId true string The ID of the application
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set
This method supports pagination.

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_autoClientMapping"
      }
    }
  }
}

Queries for Auto Client Mapping

Queries for instances of type Auto Client Mapping
POST /webhosts/{webhostId}/autoclientmappings/query

Parameters

Name Required Type Description
webhostId true string The ID of the web host
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set
This method supports pagination.

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_autoClientMapping"
      }
    }
  }
}

Read ACL

Read the Access Control List for the specified autoClientMapping
GET /webhosts/{webhostId}/autoclientmappings/{autoClientMappingId}/acl/list

Parameters

Name Required Type Description
webhostId true string The ID of the web host
autoClientMappingId true string

Response

{
  "type": "object",
  "description": "Result Map of ACL entries",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "_doc": {
            "type": "string",
            "title": "Principal ID"
          },
          "name": {
            "type": "string",
            "title": "Principal Name"
          },
          "type": {
            "type": "string",
            "title": "Principal Type"
          },
          "domainId": {
            "type": "string"
          },
          "domainQualifiedId": {
            "type": "string"
          },
          "domainQualifiedName": {
            "type": "string"
          },
          "principalId": {
            "type": "string",
            "title": "Principal ID"
          },
          "userEmail": {
            "type": "string"
          },
          "userFirstName": {
            "type": "string"
          },
          "userLastName": {
            "type": "string"
          },
          "authorities": {
            "type": "array",
            "title": "Authorities",
            "items": {
              "type": "string",
              "title": "Authority Key"
            }
          }
        }
      }
    }
  }
}

Read ACL for Principal

Read the Access Control List for the specified autoClientMapping and the given principal
GET /webhosts/{webhostId}/autoclientmappings/{autoClientMappingId}/acl

Parameters

Name Required Type Description
webhostId true string The ID of the web host
autoClientMappingId true string
id true string

Response

{
  "type": "object",
  "description": "Result Map of Authority Keys",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Authority Key"
      }
    }
  }
}

Read Authorities Report

Read the Authorities Report for the specified autoClientMapping
POST /webhosts/{webhostId}/autoclientmappings/{autoClientMappingId}/authorities

Parameters

Name Required Type Description
webhostId true string The ID of the web host
autoClientMappingId true string

Response

{
  "type": "object",
  "description": "Authority Report",
  "properties": {
    "principalId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "object",
          "properties": {
            "role-key": {
              "type": "string"
            },
            "principal": {
              "type": "string"
            },
            "permissioned": {
              "type": "string"
            },
            "inheritsFrom": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "principal": {
                  "type": "string"
                },
                "permissioned": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Read Auto Client Mapping

Reads an instance of a Auto Client Mapping
GET /webhosts/{webhostId}/autoclientmappings/{autoClientMappingId}

Parameters

Name Required Type Description
webhostId true string The ID of the web host
autoClientMappingId true string

Response

{
  "type": "object",
  "extends": "document",
  "description": "Auto Client Mapping",
  "container": "webhost",
  "properties": {
    "uri": {
      "type": "string"
    },
    "applicationId": {
      "type": "string"
    },
    "applicationKey": {
      "type": "string"
    },
    "clientKey": {
      "type": "string"
    },
    "tenantId": {
      "type": "string"
    },
    "automanage": {
      "type": "boolean"
    },
    "_doc": null,
    "_system": null
  }
}

Revoke Authority

Revokes an authority against the specified autoClientMapping from a given user
POST /webhosts/{webhostId}/autoclientmappings/{autoClientMappingId}/authorities/{authorityId}/revoke

Parameters

Name Required Type Description
webhostId true string The ID of the web host
autoClientMappingId true string
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Starts an export job for this resource

Starts an export job for this resource
POST /webhosts/{webhostId}/autoclientmappings/{autoClientMappingId}/export

Parameters

Name Required Type Description
webhostId true string The ID of the web host
autoClientMappingId true string
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Export Configuration",
  "properties": {
    "startDate": {
      "type": "object"
    },
    "endDate": {
      "type": "object"
    },
    "startChangeset": {
      "type": "string"
    },
    "endChangeset": {
      "type": "string"
    },
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}

Starts an import job for this resource

Starts an import job for this resource
POST /webhosts/{webhostId}/autoclientmappings/{autoClientMappingId}/import

Parameters

Name Required Type Description
webhostId true string The ID of the web host
autoClientMappingId true string
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Import Configuration",
  "properties": {
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "substitutions": {
      "type": "string"
    }
  }
}

Update Auto Client Mapping

Updates an existing Auto Client Mapping
PUT /webhosts/{webhostId}/autoclientmappings/{autoClientMappingId}

Parameters

Name Required Type Description
webhostId true string The ID of the web host
autoClientMappingId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update Auto Client Mapping

Updates an existing Auto Client Mapping
POST /webhosts/{webhostId}/autoclientmappings/{autoClientMappingId}/update

Parameters

Name Required Type Description
webhostId true string The ID of the web host
autoClientMappingId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Schema


{
  "type": "object",
  "extends": "document",
  "description": "Auto Client Mapping",
  "container": "webhost",
  "properties": {
    "uri": {
      "type": "string"
    },
    "applicationId": {
      "type": "string"
    },
    "applicationKey": {
      "type": "string"
    },
    "clientKey": {
      "type": "string"
    },
    "tenantId": {
      "type": "string"
    },
    "automanage": {
      "type": "boolean"
    },
    "_doc": null,
    "_system": null
  },
  "id": "autoClientMapping"
}