How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Fresnel Software Auth API

The Auth API from Fresnel Software — 11 operation(s) for auth.

Fresnel Software Auth API is one of 70 APIs that Fresnel Software publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 23 operations across 11 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://{workspace}.api.vitruvi.cc.

23 operations 11 paths 18 schemas 3 DELETE8 GET3 PATCH6 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Server
https://{workspace}.api.vitruvi.cc
Authentication
HTTP Basic, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 3

Fresnel Software Auth API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as Authorization (jwtAuth). It accepts HTTP bearer tokens (tokenAuth).

  • jwtAuth — Token-based authentication with required prefix "JWT"

Paths & Operations 23

Across 11 paths, the API surfaces 23 operations — 3 DELETE, 8 GET, 3 PATCH, 6 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Auth 23
GET
/auth/permissions/
List Permissions
list_permissions 7 params → 200
POST
/auth/permissions/
Create Permission
create_permission body → 201
GET
/auth/permissions/{id}/
Get Permission
get_permission 1 param → 200
PUT
/auth/permissions/{id}/
Update Permission
update_permission 1 param body → 200
PATCH
/auth/permissions/{id}/
Patch Permission
patch_permission 1 param body → 200
DELETE
/auth/permissions/{id}/
Delete Permission
delete_permission 1 param → 204
GET
/auth/security_groups/
List Security Groups
list_security_groups 6 params → 200
POST
/auth/security_groups/
Create Security Group
create_security_group body → 201
GET
/auth/security_groups/{id}/
Get Security Group
get_security_group 1 param → 200
PUT
/auth/security_groups/{id}/
Update Security Group
update_security_group 1 param body → 200
PATCH
/auth/security_groups/{id}/
Patch Security Group
patch_security_group 1 param body → 200
DELETE
/auth/security_groups/{id}/
Delete Security Group
delete_security_group 1 param → 204
POST
/auth/token/obtain
Obtain JWT
obtain_token body → 200
POST
/auth/token/refresh
Refresh JWT
refresh_token body → 200
POST
/auth/token/verify
Verify JWT
verify_token body → 200
GET
/auth/user_info
Get Current User Info
current_user_info → 200
GET
/auth/users/deprecated
List Accounts
list_auth_users 7 params → 200
POST
/auth/users/deprecated
Create Account
create_auth_users body → 201
GET
/auth/users/{id}/deprecated
Retrieve Account
get_auth_users 1 param → 200
PUT
/auth/users/{id}/deprecated
Update Account
update_auth_users 1 param body → 200
PATCH
/auth/users/{id}/deprecated
Partial Update Account
patch_auth_users 1 param body → 200
DELETE
/auth/users/{id}/deprecated
Delete Account
delete_auth_users 1 param → 204
GET
/auth/v1/workato_embedded_url
Get integration engine url
get_integration_engine_url → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are Profile (35 properties), PatchedAccount (6 properties), Account (6 properties), UserInfo (5 properties). Each schema is shown below with its type and property counts.

BlankEnum
Role
object
3 properties 2 required
PatchedPermission
object
3 properties
PatchedAccount
object
6 properties
PaginatedRoleList
object
4 properties
CompanyTypeEnum
string
NO - NO EPC - EPC SC - SC
VerifyJSONWebToken
object
Check the veracity of an access token.
1 property 1 required
WebToken
object
Serializer class used to validate a username and password. 'username' is identified by the custom UserModel.USERNAMEFIELD. Returns a JSON Web Token that can be…
2 properties 2 required
RefreshToken
object
Refresh an access token.
1 property 1 required
FullCrewPersonRole
object
4 properties 4 required
Account
object
6 properties 3 required
UserInfo
object
5 properties 5 required
PaginatedAccountList
object
4 properties
PatchedRole
object
3 properties
PaginatedPermissionList
object
4 properties
UserTierEnum
string
Office User - Office User Field User - Field User Read Only - Read Only Support - Support Service - Service No Login - No Login
Permission
object
3 properties 3 required
Profile
object
35 properties 17 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vitruvi-auth-api-openapi.yml Raw ↑

Other APIs Fresnel Software publishes across the network.

Vitruvi Platform
Fresnel Software Aggregation API
Fresnel Software Ai agent API
Fresnel Software Async events API
Fresnel Software Conditional custom field overrides API
Fresnel Software Configuration library API
Fresnel Software Content types API
Fresnel Software Crew categories API
Fresnel Software Crews API
Fresnel Software Crews with resources API
Fresnel Software Custom field categories API
Fresnel Software Custom field settings API
Where this information came from

This is an independent, third-party profile of Fresnel Software Auth API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.