SecurityService Resource

GET /security/v2/children

Get a list of all the security artifacts

Request Parameters
name type description constraints
count query Max number of children NodeData to return (optional) int
pos query Opaque string used to keep position (optional)  
Response Body
media type data type description
application/familysearch+xml securityChildren (XML) SecurityChildren
application/json SecurityChildren (JSON)
application/xml securityChildren (XML)
text/xml securityChildren (XML)

Example

Request
GET /security/v2/children
Accept: application/familysearch+xml

              
Response
HTTP/1.1 200 OK
Content-Type: application/familysearch+xml

                
<securityChildren position="..." xmlns="http://digitalarchive.familysearch.org/v1">
  <childrenApidList>...</childrenApidList>
</securityChildren>

                
              

POST /security/v2/children

Create a security artifact

Request Parameters
name type description
apid query Apid to use to create this node (optional)
Request Body
media type data type description
application/familysearch+xml securityNode (XML) Can be optionally populated with the security parent and/or actions. The children member will be ignored.
application/json SecurityNode (JSON)
application/xml securityNode (XML)
Response Body
media type data type description
application/familysearch+xml apid (XML) Apid - the apid of the new artifact.
application/json Apid (JSON)
application/xml apid (XML)
text/xml apid (XML)

Example

Request
POST /security/v2/children
Content-Type: application/familysearch+xml
Accept: application/familysearch+xml

                
<securityNode apid="..." securityParent="..." xmlns="http://digitalarchive.familysearch.org/v1">
  <actions>...</actions>
  <childCount>...</childCount>
  <propertyList name="..." value="..."/>
</securityNode>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/familysearch+xml

                
<apid value="..." xmlns="http://digitalarchive.familysearch.org/v1"/>

                
              

POST /security/v2/restrictions

Get restricted state for nodes

Request Body
media type data type description
application/familysearch+xml existsListQuery (XML) List of nodes to get restrictions on
application/json ExistsListQuery (JSON)
application/xml existsListQuery (XML)
Response Body
media type data type description
application/familysearch+xml restrictData (XML) SecurityChildren
application/json RestrictData (JSON)
application/xml restrictData (XML)
text/xml restrictData (XML)

Example

Request
POST /security/v2/restrictions
Content-Type: application/familysearch+xml
Accept: application/familysearch+xml

                
<existsListQuery xmlns="http://digitalarchive.familysearch.org/v1">
  <nodeLocatorList>...</nodeLocatorList>
</existsListQuery>

                
              
Response
HTTP/1.1 201 Created
Content-Type: application/familysearch+xml

                
<restrictData xmlns="http://digitalarchive.familysearch.org/v1">
  <nodes locator="..." restricted="..."/>
</restrictData>

                
              

GET /security/v2/root

Get the security root apid

Response Body
media type data type description
application/familysearch+xml apid (XML) Apid
application/json Apid (JSON)
application/xml apid (XML)
text/xml apid (XML)

Example

Request
GET /security/v2/root
Accept: application/familysearch+xml

              
Response
HTTP/1.1 200 OK
Content-Type: application/familysearch+xml

                
<apid value="..." xmlns="http://digitalarchive.familysearch.org/v1"/>

                
              

DELETE /security/v2/{nodeLocator}

Delete security artifact

Request Parameters
name type description
nodeLocator path String used to identify the node, e.g. apid:{apid}, dgs:{9}.{9-5}

Example

Request
DELETE /security/v2/{nodeLocator}

              
Response
HTTP/1.1 204 No Content

              

GET /security/v2/{nodeLocator}

Request Parameters
name type description
nodeLocator path String used to identify the node, e.g. apid:{apid}, dgs:{9}.{9-5}
Response Body
media type data type description
application/familysearch+xml securityNode (XML) SecurityNode
application/json SecurityNode (JSON)
application/xml securityNode (XML)
text/xml securityNode (XML)

Example

Request
GET /security/v2/{nodeLocator}
Accept: application/familysearch+xml

              
Response
HTTP/1.1 200 OK
Content-Type: application/familysearch+xml

                
<securityNode apid="..." securityParent="..." xmlns="http://digitalarchive.familysearch.org/v1">
  <actions>...</actions>
  <childCount>...</childCount>
  <propertyList name="..." value="..."/>
</securityNode>

                
              

GET /security/v2/{nodeLocator}/actions

Get the security actions for this artifact

Request Parameters
name type description
nodeLocator path String used to identify the node, e.g. apid:{apid}, dgs:{9}.{9-5}
Response Body
media type data type description
application/familysearch+xml actions (XML) Actions
application/json Actions (JSON)
application/xml actions (XML)
text/xml actions (XML)

Example

Request
GET /security/v2/{nodeLocator}/actions
Accept: application/familysearch+xml

              
Response
HTTP/1.1 200 OK
Content-Type: application/familysearch+xml

                
<actions xmlns="http://digitalarchive.familysearch.org/v1">
  <actionList>...</actionList>
</actions>

                
              

PUT /security/v2/{nodeLocator}/actions

Set the security actions for the artifact

Request Parameters
name type description
nodeLocator path String used to identify the node, e.g. apid:{apid}, dgs:{9}.{9-5}
Request Body
media type data type description
application/familysearch+xml actions (XML) Actions for this node, ie view, print ...
application/json Actions (JSON)
application/xml actions (XML)

Example

Request
PUT /security/v2/{nodeLocator}/actions
Content-Type: application/familysearch+xml

                
<actions xmlns="http://digitalarchive.familysearch.org/v1">
  <actionList>...</actionList>
</actions>

                
              
Response
HTTP/1.1 204 No Content

              

GET /security/v2/{nodeLocator}/cas

Request Parameters
name type description
nodeLocator path String used to identify the node, e.g. apid:{apid}, dgs:{9}.{9-5}
action query action to perform on the permission
Response Body
media type data type description
application/familysearch+xml permissionData (XML) PermissionData CAS permission information for the node
application/json PermissionData (JSON)
application/xml permissionData (XML)
text/xml permissionData (XML)

Example

Request
GET /security/v2/{nodeLocator}/cas
Accept: application/familysearch+xml

              
Response
HTTP/1.1 200 OK
Content-Type: application/familysearch+xml

                
<permissionData permission="..." unrestricted="..." xmlns="http://digitalarchive.familysearch.org/v1">
  <securityProperties name="..." value="..."/>
</permissionData>

                
              

GET /security/v2/{nodeLocator}/children

Get security aritfact security children

Request Parameters
name type description constraints
nodeLocator path String used to identify the node, e.g. apid:{apid}, dgs:{9}.{9-5}  
count query Max number of children NodeData to return (optional) int
pos query Opaque string used to keep position (optional)  
Response Body
media type data type description
application/familysearch+xml securityChildren (XML) SecurityChildren
application/json SecurityChildren (JSON)
application/xml securityChildren (XML)
text/xml securityChildren (XML)

Example

Request
GET /security/v2/{nodeLocator}/children
Accept: application/familysearch+xml

              
Response
HTTP/1.1 200 OK
Content-Type: application/familysearch+xml

                
<securityChildren position="..." xmlns="http://digitalarchive.familysearch.org/v1">
  <childrenApidList>...</childrenApidList>
</securityChildren>

                
              

GET /security/v2/{nodeLocator}/parent

Get security parent for this artifact

Request Parameters
name type description
nodeLocator path String used to identify the node, e.g. apid:{apid}, dgs:{9}.{9_5}
Response Body
media type data type description
application/familysearch+xml apid (XML) Apid Parent artifact identifier
application/json Apid (JSON)
application/xml apid (XML)
text/xml apid (XML)

Example

Request
GET /security/v2/{nodeLocator}/parent
Accept: application/familysearch+xml

              
Response
HTTP/1.1 200 OK
Content-Type: application/familysearch+xml

                
<apid value="..." xmlns="http://digitalarchive.familysearch.org/v1"/>

                
              

PUT /security/v2/{nodeLocator}/parent

Link this artifact to security parent artifact

Request Parameters
name type description
nodeLocator path String used to identify the node, e.g. apid:{apid}, dgs:{9}.{9-5}
Request Body
media type data type description
application/familysearch+xml apid (XML) Apid: parent node
application/json Apid (JSON)
application/xml apid (XML)

Example

Request
PUT /security/v2/{nodeLocator}/parent
Content-Type: application/familysearch+xml

                
<apid value="..." xmlns="http://digitalarchive.familysearch.org/v1"/>

                
              
Response
HTTP/1.1 204 No Content

              

GET /security/v2/{nodeLocator}/permission

Request Parameters
name type description
nodeLocator path String used to identify the node, e.g. apid:{apid}, dgs:{9}.{9-5}
action query action to perform on the permission
Response Body
media type data type
application/json string (JSON)
application/xml string (XML)

Example

Request
GET /security/v2/{nodeLocator}/permission
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...
                
              

GET /security/v2/{nodeLocator}/properties

Get the security actions for this artifact

Request Parameters
name type description
nodeLocator path String used to identify the node, e.g. apid:{apid}, dgs:{9}.{9-5}
Response Body
media type data type description
application/familysearch+xml securityPropertyList (XML) Actions
application/json SecurityPropertyList (JSON)
application/xml securityPropertyList (XML)
text/xml securityPropertyList (XML)

Example

Request
GET /security/v2/{nodeLocator}/properties
Accept: application/familysearch+xml

              
Response
HTTP/1.1 200 OK
Content-Type: application/familysearch+xml

                
<securityPropertyList xmlns="http://digitalarchive.familysearch.org/v1">
  <propertyList name="..." value="..."/>
</securityPropertyList>

                
              

PUT /security/v2/{nodeLocator}/properties

Set the security actions for the artifact

Request Parameters
name type description
nodeLocator path String used to identify the node, e.g. apid:{apid}, dgs:{9}.{9-5}
Request Body
media type data type
application/familysearch+xml securityPropertyList (XML)
application/json SecurityPropertyList (JSON)
application/xml securityPropertyList (XML)

Example

Request
PUT /security/v2/{nodeLocator}/properties
Content-Type: application/familysearch+xml

                
<securityPropertyList xmlns="http://digitalarchive.familysearch.org/v1">
  <propertyList name="..." value="..."/>
</securityPropertyList>

                
              
Response
HTTP/1.1 204 No Content