Socotra Auth API
The Auth API from Socotra — 41 operation(s) for auth.
The Auth API from Socotra — 41 operation(s) for auth.
openapi: 3.0.1
info:
title: Socotra Insurance Suite OpenAPI Definition Auth API
description: Socotra Insurance Suite API
termsOfService: https://www.socotra.com
version: v0
servers:
- url: /
description: Generated server url
tags:
- name: Auth
paths:
/auth/identity/passwordPolicy:
get:
operationId: fetchPasswordPolicy
parameters: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordPolicyResponse'
deprecated: false
x-securityGroup: identity
x-securityPermission:
- read
- custom
deprecated: false
tags:
- Auth
put:
operationId: updatePasswordPolicy
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordPolicyUpdateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
x-securityGroup: identity
x-securityPermission:
- add
- custom
deprecated: false
tags:
- Auth
/auth/users:
post:
operationId: createUser
parameters:
- name: enableUser
in: query
description: When true, user will be active (enabled) even if password is not set. Useful for SSO since user cannot use any other credentials to log in
required: false
schema:
type: boolean
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserCreateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- add
deprecated: false
tags:
- Auth
/auth/users/{locator}/tokens:
get:
operationId: fetchAuthTokensForUser
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
deprecated: false
items:
$ref: '#/components/schemas/AuthTokenResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- read
- custom
deprecated: false
tags:
- Auth
post:
operationId: createServiceAccountAuthToken
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthTokenCreateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: string
deprecated: false
x-securityGroup: users
x-securityPermission:
- custom
deprecated: false
tags:
- Auth
/auth/users/{locator}/revoke:
post:
operationId: revokeUserOauthTokens
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
x-securityGroup: users
x-securityPermission:
- write
- custom
- revoke
deprecated: false
tags:
- Auth
/auth/users/tokens:
get:
operationId: fetchAuthTokens
parameters: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
deprecated: false
items:
$ref: '#/components/schemas/AuthTokenResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- read
- custom
deprecated: false
tags:
- Auth
post:
operationId: createAuthToken
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthTokenCreateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: string
deprecated: false
x-securityGroup: users
x-securityPermission:
- write
- token
deprecated: false
tags:
- Auth
/auth/users/tokens/permissions:
post:
operationId: getGroupedTokenPermissions
parameters: []
requestBody:
content:
application/json:
schema:
type: string
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
deprecated: false
additionalProperties:
type: array
deprecated: false
items:
type: string
deprecated: false
x-securityGroup: users
x-securityPermission:
- read
- custom
deprecated: false
tags:
- Auth
/auth/roles:
post:
operationId: createRole
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoleCreateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RoleResponse'
deprecated: false
x-securityGroup: roles
x-securityPermission:
- add
deprecated: false
tags:
- Auth
/auth/roles/tenant/{tenantLocator}/{roleLocator}:
get:
operationId: getTenantRole
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: roleLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RoleResponse'
deprecated: false
x-securityGroup: roles
x-securityPermission:
- read
deprecated: false
tags:
- Auth
post:
operationId: createTenantRole
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: roleLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTenantRoleReq'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RoleResponse'
deprecated: false
x-securityGroup: roles
x-securityPermission:
- add
deprecated: false
tags:
- Auth
patch:
operationId: updateTenantRole
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: roleLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchTenantRoleReq'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RoleResponse'
deprecated: false
x-securityGroup: roles
x-securityPermission:
- update
deprecated: false
tags:
- Auth
delete:
operationId: deleteTenantRole
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: roleLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
x-securityGroup: roles
x-securityPermission:
- delete
deprecated: false
tags:
- Auth
/auth/identity:
post:
operationId: createIdentityProvider
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SAMLIdentityProviderCreateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/IdentityProviderResponse'
deprecated: false
x-securityGroup: identity
x-securityPermission:
- add
- custom
deprecated: true
tags:
- Auth
/auth/identity/saml:
post:
operationId: addSAMLIdentityProvider
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SAMLIdentityProviderCreateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/IdentityProviderResponse'
deprecated: false
x-securityGroup: identity
x-securityPermission:
- add
- custom
deprecated: false
tags:
- Auth
/auth/identity/oidc:
post:
operationId: addOIDCIdentityProvider
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OIDCIdentityProviderCreateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/IdentityProviderResponse'
deprecated: false
x-securityGroup: identity
x-securityPermission:
- add
- custom
deprecated: false
tags:
- Auth
/auth/users/{locator}:
get:
operationId: fetchUserByLocator
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- custom
- read
deprecated: false
tags:
- Auth
patch:
operationId: updateUser
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserUpdateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- update
- custom
deprecated: false
tags:
- Auth
delete:
operationId: deleteUser
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
x-securityGroup: users
x-securityPermission:
- delete
deprecated: false
tags:
- Auth
/auth/users/{locator}/tenants:
patch:
operationId: updateUserTenantAssignments
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserTenantsAssignmentsUpdateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- update-tenants
deprecated: false
tags:
- Auth
/auth/users/{locator}/roles:
patch:
operationId: updateUserRoles
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserRolesUpdateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- update-roles
deprecated: false
tags:
- Auth
/auth/users/{locator}/passwordreset:
patch:
operationId: resetUserPassword
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
type: string
deprecated: false
required: true
responses:
'200':
description: OK
x-securityGroup: users
x-securityPermission:
- password-reset
deprecated: false
tags:
- Auth
/auth/users/{locator}/enable:
patch:
operationId: enableUser
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- enable
deprecated: false
tags:
- Auth
/auth/users/{locator}/dataaccess/{tenantLocator}:
get:
operationId: fetchUserDataAccessForTenant
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserDataAccessResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- read
deprecated: false
tags:
- Auth
patch:
operationId: addUserDataAccess
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserDataAccessRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserDataAccessResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- write
deprecated: false
tags:
- Auth
delete:
operationId: deleteUserDataAccess
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
x-securityGroup: users
x-securityPermission:
- write
deprecated: false
tags:
- Auth
/auth/users/{locator}/accessmask:
get:
operationId: fetchUserMasks
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
deprecated: false
items:
$ref: '#/components/schemas/UserDataAccessControlMaskResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- read
deprecated: true
tags:
- Auth
patch:
operationId: addDataSecurityMask
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserDataSecurityMaskRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserDataAccessControlMaskResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- write
deprecated: true
tags:
- Auth
/auth/tenants/{locator}:
get:
operationId: fetchTenant
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TenantResponse'
deprecated: false
x-securityGroup: tenants
x-securityPermission:
- read
deprecated: false
tags:
- Auth
patch:
operationId: updateTenant
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TenantUpdateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TenantResponse'
deprecated: false
x-securityGroup: tenants
x-securityPermission:
- write
deprecated: false
tags:
- Auth
/auth/tenants/{locator}/retire:
patch:
operationId: retireTenant
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TenantResponse'
deprecated: false
x-securityGroup: tenants
x-securityPermission:
- retire
deprecated: false
tags:
- Auth
/auth/roles/{locator}:
get:
operationId: getRole
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RoleResponse'
deprecated: false
x-securityGroup: roles
x-securityPermission:
- read
deprecated: false
tags:
- Auth
patch:
operationId: updateRole
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoleUpdateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RoleResponse'
deprecated: false
x-securityGroup: roles
x-securityPermission:
- update
deprecated: false
tags:
- Auth
delete:
operationId: deleteRole
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
x-securityGroup: roles
x-securityPermission:
- delete
deprecated: false
tags:
- Auth
/auth/users/{userLocator}/tenant/{tenantLocator}/permissions:
get:
operationId: fetchUserTenantPermissions
parameters:
- name: userLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
deprecated: false
items:
type: string
deprecated: false
x-securityGroup: users
x-securityPermission:
- read
- custom
deprecated: false
tags:
- Auth
/auth/users/{locator}/permissions:
get:
operationId: fetchUserPermissions
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
deprecated: false
items:
type: string
deprecated: false
x-securityGroup: users
x-securityPermission:
- read
- custom
deprecated: false
tags:
- Auth
/auth/users/{locator}/dataaccess:
get:
operationId: fetchUserDataAccess
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
deprecated: false
items:
$ref: '#/components/schemas/UserDataAccessResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- read
deprecated: false
tags:
- Auth
/auth/users/{locator}/credentialStatus:
get:
operationId: fetchCredentialStatus
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- read
- custom
deprecated: false
tags:
- Auth
/auth/users/{locator}/accessmask/{tenantLocator}:
get:
operationId: fetchUserMasksForTenant
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
deprecated: false
items:
$ref: '#/components/schemas/UserDataAccessControlMaskResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- read
deprecated: true
tags:
- Auth
delete:
operationId: deleteUserMasks
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
x-securityGroup: users
x-securityPermission:
- write
deprecated: true
tags:
- Auth
/auth/users/{locator}/accessmask/{tenantLocator}/{type}:
get:
operationId: fetchUserMask
parameters:
- name: locator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: type
in: path
required: true
schema:
type: string
enum:
- account
- policy
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserDataAccessControlMaskResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- read
deprecated: true
tags:
- Auth
/auth/users/whoami:
get:
operationId: fetchMyUserDetails
parameters: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- custom
deprecated: false
tags:
- Auth
/auth/users/username/{username}:
get:
operationId: fetchUserByName
parameters:
- name: username
in: path
required: true
schema:
type: string
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
deprecated: false
items:
$ref: '#/components/schemas/UserResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- read
deprecated: false
tags:
- Auth
/auth/users/list:
get:
operationId: fetchMultipleUsers
parameters:
- name: offset
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: count
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: extended
in: query
description: When false, returns a bare array.
required: false
schema:
type: boolean
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserListResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- read
- list
deprecated: false
tags:
- Auth
/auth/users/basic/list:
get:
operationId: fetchMultipleBasicUsers
description: This endpoint returns a simplified response and therefore has a higher count limit compared to 'fetchMultipleUsers'.
parameters:
- name: offset
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: count
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: extended
in: query
required: false
schema:
type: boolean
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BasicUserResponse'
deprecated: false
x-securityGroup: users
x-securityPermission:
- read
- list
deprecated: false
tags:
- Auth
/auth/tenants/mytenants/list:
get:
operationId: fetchMyTenants
description: Returns a list of tenants you have access to.
parameters:
- name: offset
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: count
in: query
required: false
schema:
type: integer
format: int32
deprecated: false
- name: extended
in: query
description: When false, returns a bare array.
required: false
schema:
type: boolean
deprecated: false
responses:
'
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/socotra/refs/heads/main/openapi/socotra-auth-api-openapi.yml