Satosa (0.0.0)

Download OpenAPI specification:Download

License:

Satosa API specification.

Documents

Document management API

Lists documents.

Authorizations:

Authorization

query Parameters

limit	integer or null <int64> The maximum number of items to return
next	string or null The cursor of the first document of the next page
prev	string or null The cursor of the last document of the previous page

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"cursor": {"next": "string",
"prev": "string"
},
"items": [{"created_at": "2019-08-24T14:15:22Z",
"custom_style": {"primary": "string",
"secondary": "string",
"text": "string",
"trim": "string"
},
"id": "string",
"modified_at": "2019-08-24T14:15:22Z",
"name": "string",
"published_revision": 0,
"signature_method": "clickwrap",
"status": "active"
}
]
}

Creates a new document in the organization.

Authorizations:

Authorization

Request Body schema: application/json

The document information.

name

required

string

The name of the document

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200
400
401
403
500

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"custom_style": {"primary": "string",
"secondary": "string",
"text": "string",
"trim": "string"
},
"id": "string",
"modified_at": "2019-08-24T14:15:22Z",
"name": "string",
"published_revision": 0,
"signature_method": "clickwrap",
"status": "active"
}

Get the details of a document.

Authorizations:

Authorization

path Parameters

document_id

required

string

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"custom_style": {"primary": "string",
"secondary": "string",
"text": "string",
"trim": "string"
},
"id": "string",
"modified_at": "2019-08-24T14:15:22Z",
"name": "string",
"published_revision": 0,
"signature_method": "clickwrap",
"status": "active"
}

Updates an existing document

Authorizations:

Authorization

path Parameters

document_id

required

string

Request Body schema: application/json

The document information.

	object or null
name required	string The name of the document
signature_method required	string (SignatureMethodSchema) Enum: "clickwrap" "scrollwrap" "esignature"

Responses

Request samples

Payload

Content type

application/json

{"custom_style": {"primary": "string",
"secondary": "string",
"text": "string",
"trim": "string"
},
"name": "string",
"signature_method": "clickwrap"
}

Response samples

200
400
401
403
500

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"custom_style": {"primary": "string",
"secondary": "string",
"text": "string",
"trim": "string"
},
"id": "string",
"modified_at": "2019-08-24T14:15:22Z",
"name": "string",
"published_revision": 0,
"signature_method": "clickwrap",
"status": "active"
}

Archives a document

Authorizations:

Authorization

path Parameters

document_id

required

string

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"custom_style": {"primary": "string",
"secondary": "string",
"text": "string",
"trim": "string"
},
"id": "string",
"modified_at": "2019-08-24T14:15:22Z",
"name": "string",
"published_revision": 0,
"signature_method": "clickwrap",
"status": "active"
}

Revise a Document

Updates the contents of the latest revision if the revision is still editable. Otherwise, creates a new revision with the provided contents.

Authorizations:

Authorization

path Parameters

document_id

required

string

Request Body schema: application/json

The revision contents and description.

content required	string The content of the revision
description	string or null The description of the changes since the previous revision

Responses

Request samples

Payload

Content type

application/json

{"content": "string",
"description": "string"
}

Response samples

200
400
401
403
500

Content type

application/json

{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"document_id": "string",
"modified_at": "2019-08-24T14:15:22Z",
"revision_id": 0,
"status": "read_write"
}

List document revisions.

Authorizations:

Authorization

path Parameters

document_id

required

string

query Parameters

limit	integer or null <int64> The maximum number of items to return
next	string or null The cursor of the first document of the next page
prev	string or null The cursor of the last document of the previous page

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"cursor": {"next": "string",
"prev": "string"
},
"items": [{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"document_id": "string",
"modified_at": "2019-08-24T14:15:22Z",
"revision_id": 0,
"status": "read_write"
}
]
}

Get Revision

Get a revision's details and contents.

Authorizations:

Authorization

path Parameters

document_id required	string
revision_id required	integer <int64>

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"document_id": "string",
"modified_at": "2019-08-24T14:15:22Z",
"revision_id": 0,
"status": "read_write"
}

Publish Revision

Sets the revision to read-only if needed and updates the document's published revision.

Authorizations:

Authorization

path Parameters

document_id required	string
revision_id required	integer <int64>

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"document_id": "string",
"modified_at": "2019-08-24T14:15:22Z",
"revision_id": 0,
"status": "read_write"
}

Public Documents

Public document API

Get Published Content

Get the document's published revision's contnet

Authorizations:

Authorization

path Parameters

organization_id required	string
document_id required	string

query Parameters

revision_id

integer or null <int64>

The id of the specific revision to fetch.

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"custom_style": {"primary": "string",
"secondary": "string",
"text": "string",
"trim": "string"
},
"document_id": "string",
"document_name": "string",
"modified_at": "2019-08-24T14:15:22Z",
"revision_id": 0,
"signature_method": "clickwrap"
}

Interactions

Interaction management API

List interactions

Authorizations:

Authorization

query Parameters

user_key	string or null The specific user key to filter on
document_id	string or null The specific document id to filter on
revision_id	integer or null <int64> The specific revision id to filter on
limit	integer or null <int64> The maximum number of items to return
next	string or null The cursor of the first document of the next page
prev	string or null The cursor of the last document of the previous page

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"cursor": {"next": "string",
"prev": "string"
},
"items": [{"created_at": "2019-08-24T14:15:22Z",
"custom_attributes": {"property1": "string",
"property2": "string"
},
"document_id": "string",
"esignature": "string",
"id": "string",
"modified_at": "2019-08-24T14:15:22Z",
"revision_id": 0,
"system_attributes": {"ip_address": "string",
"user_agent": "string"
},
"user_attributes": {"email_address": "user@example.com",
"family_name": "string",
"given_name": "string",
"phone_number": "string"
},
"user_key": "string"
}
]
}

Creates a new interaction

Authorizations:

Authorization

Request Body schema: application/json

The interaction information.

	object or null The set of custom attributes associated with the user.
document_id required	string The unique identifier of the associated document
esignature	string or null An optional esignature to sign the document
revision_id required	integer <int64> The revision of the associated document
	object or null
user_key required	string The key to uniquely identify the user. Required for public and private flows.

Responses

Request samples

Payload

Content type

application/json

{"custom_attributes": {"property1": "string",
"property2": "string"
},
"document_id": "string",
"esignature": "string",
"revision_id": 0,
"user_attributes": {"email_address": "user@example.com",
"family_name": "string",
"given_name": "string",
"phone_number": "string"
},
"user_key": "string"
}

Response samples

200
400
401
403
500

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"custom_attributes": {"property1": "string",
"property2": "string"
},
"document_id": "string",
"esignature": "string",
"id": "string",
"modified_at": "2019-08-24T14:15:22Z",
"revision_id": 0,
"system_attributes": {"ip_address": "string",
"user_agent": "string"
},
"user_attributes": {"email_address": "user@example.com",
"family_name": "string",
"given_name": "string",
"phone_number": "string"
},
"user_key": "string"
}

Get the details of an interaction

Authorizations:

Authorization

path Parameters

interaction_id

required

string

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"custom_attributes": {"property1": "string",
"property2": "string"
},
"document_id": "string",
"esignature": "string",
"id": "string",
"modified_at": "2019-08-24T14:15:22Z",
"revision_id": 0,
"system_attributes": {"ip_address": "string",
"user_agent": "string"
},
"user_attributes": {"email_address": "user@example.com",
"family_name": "string",
"given_name": "string",
"phone_number": "string"
},
"user_key": "string"
}

Sessions

Session management API

Creates a new session

Authorizations:

Authorization

Request Body schema: application/json

The session information.

	object or null The set of custom attributes associated with the user.
	object or null
user_key required	string The key to uniquely identify the user. Required for public and private flows.

Responses

Request samples

Payload

Content type

application/json

{"custom_attributes": {"property1": "string",
"property2": "string"
},
"user_attributes": {"email_address": "user@example.com",
"family_name": "string",
"given_name": "string",
"phone_number": "string"
},
"user_key": "string"
}

Response samples

200
400
401
403
500

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"custom_attributes": {"property1": "string",
"property2": "string"
},
"id": "string",
"modified_at": "2019-08-24T14:15:22Z",
"user_attributes": {"email_address": "user@example.com",
"family_name": "string",
"given_name": "string",
"phone_number": "string"
},
"user_key": "string"
}

Submit a session

Authorizations:

Authorization

path Parameters

session_id

required

string

Request Body schema: application/json

The interaction information.

document_id required	string The unique identifier of the associated document
esignature	string or null The optional esignature to sign the document with
revision_id required	integer <int64> The revision of the associated document

Responses

Request samples

Payload

Content type

application/json

{"document_id": "string",
"esignature": "string",
"revision_id": 0
}

Response samples

200
400
401
403
500

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"custom_attributes": {"property1": "string",
"property2": "string"
},
"document_id": "string",
"esignature": "string",
"id": "string",
"modified_at": "2019-08-24T14:15:22Z",
"revision_id": 0,
"system_attributes": {"ip_address": "string",
"user_agent": "string"
},
"user_attributes": {"email_address": "user@example.com",
"family_name": "string",
"given_name": "string",
"phone_number": "string"
},
"user_key": "string"
}