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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Socotra

Socotra Auth API

The Auth API from Socotra — 41 operation(s) for auth.

Documentation Provider Profile APIs.io OpenAPI GitHub

Socotra Auth API is one of 18 APIs that Socotra 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 57 operations across 41 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version v0.

Requests are made against a single base URL, /.

57 operations 41 paths 31 schemas 9 DELETE26 GET11 PATCH10 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v0
Base URL
https://api.sandbox.socotra.com
Terms of Service
View terms
Resource Areas
1

Paths & Operations 57

Across 41 paths, the API surfaces 57 operations — 9 DELETE, 26 GET, 11 PATCH, 10 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Auth 57
GET
/auth/identity/passwordPolicy
fetchPasswordPolicy → 200
PUT
/auth/identity/passwordPolicy
updatePasswordPolicy body → 200
POST
/auth/users
createUser 1 param body → 200
GET
/auth/users/{locator}/tokens
fetchAuthTokensForUser 1 param → 200
POST
/auth/users/{locator}/tokens
createServiceAccountAuthToken 1 param body → 200
POST
/auth/users/{locator}/revoke
revokeUserOauthTokens 1 param → 200
GET
/auth/users/tokens
fetchAuthTokens → 200
POST
/auth/users/tokens
createAuthToken body → 200
POST
/auth/users/tokens/permissions
getGroupedTokenPermissions body → 200
POST
/auth/roles
createRole body → 200
GET
/auth/roles/tenant/{tenantLocator}/{roleLocator}
getTenantRole 2 params → 200
POST
/auth/roles/tenant/{tenantLocator}/{roleLocator}
createTenantRole 2 params body → 200
PATCH
/auth/roles/tenant/{tenantLocator}/{roleLocator}
updateTenantRole 2 params body → 200
DELETE
/auth/roles/tenant/{tenantLocator}/{roleLocator}
deleteTenantRole 2 params → 200
POST
/auth/identitydeprecated
createIdentityProvider body → 200
POST
/auth/identity/saml
addSAMLIdentityProvider body → 200
POST
/auth/identity/oidc
addOIDCIdentityProvider body → 200
GET
/auth/users/{locator}
fetchUserByLocator 1 param → 200
PATCH
/auth/users/{locator}
updateUser 1 param body → 200
DELETE
/auth/users/{locator}
deleteUser 1 param → 200
PATCH
/auth/users/{locator}/tenants
updateUserTenantAssignments 1 param body → 200
PATCH
/auth/users/{locator}/roles
updateUserRoles 1 param body → 200
PATCH
/auth/users/{locator}/passwordreset
resetUserPassword 1 param body → 200
PATCH
/auth/users/{locator}/enable
enableUser 1 param → 200
GET
/auth/users/{locator}/dataaccess/{tenantLocator}
fetchUserDataAccessForTenant 2 params → 200
PATCH
/auth/users/{locator}/dataaccess/{tenantLocator}
addUserDataAccess 2 params body → 200
DELETE
/auth/users/{locator}/dataaccess/{tenantLocator}
deleteUserDataAccess 2 params → 200
GET
/auth/users/{locator}/accessmaskdeprecated
fetchUserMasks 1 param → 200
PATCH
/auth/users/{locator}/accessmaskdeprecated
addDataSecurityMask 1 param body → 200
GET
/auth/tenants/{locator}
fetchTenant 1 param → 200
PATCH
/auth/tenants/{locator}
updateTenant 1 param body → 200
PATCH
/auth/tenants/{locator}/retire
retireTenant 1 param → 200
GET
/auth/roles/{locator}
getRole 1 param → 200
PATCH
/auth/roles/{locator}
updateRole 1 param body → 200
DELETE
/auth/roles/{locator}
deleteRole 1 param → 200
GET
/auth/users/{userLocator}/tenant/{tenantLocator}/permissions
fetchUserTenantPermissions 2 params → 200
GET
/auth/users/{locator}/permissions
fetchUserPermissions 1 param → 200
GET
/auth/users/{locator}/dataaccess
fetchUserDataAccess 1 param → 200
GET
/auth/users/{locator}/credentialStatus
fetchCredentialStatus 1 param → 200
GET
/auth/users/{locator}/accessmask/{tenantLocator}deprecated
fetchUserMasksForTenant 2 params → 200
DELETE
/auth/users/{locator}/accessmask/{tenantLocator}deprecated
deleteUserMasks 2 params → 200
GET
/auth/users/{locator}/accessmask/{tenantLocator}/{type}deprecated
fetchUserMask 3 params → 200
GET
/auth/users/whoami
fetchMyUserDetails → 200
GET
/auth/users/username/{username}
fetchUserByName 1 param → 200
GET
/auth/users/list
fetchMultipleUsers 3 params → 200
GET
/auth/users/basic/list
This endpoint returns a simplified response and therefore has a higher count limit compared to 'fetchMultipleUsers'.
fetchMultipleBasicUsers 3 params → 200
GET
/auth/tenants/mytenants/list
Returns a list of tenants you have access to.
fetchMyTenants 3 params → 200
GET
/auth/tenants/list
fetchTenants 4 params → 200
GET
/auth/roles/tenant/{tenantLocator}/list
listTenantRoles 3 params → 200
GET
/auth/roles/permissions
fetchAvailablePermissions → 200
GET
/auth/roles/list
fetchMultipleRoles 3 params → 200
GET
/auth/identity/instances
fetchIdentityProviders → 200
GET
/auth/identity/instances/{name}
fetchIdentityProviderByName 1 param → 200
DELETE
/auth/identity/instances/{name}
deleteIdentityServerInstance 1 param → 200
DELETE
/auth/users/{locator}/tokens/{tokenOrName}
deleteAuthTokenForUser 2 params → 200
DELETE
/auth/users/{locator}/credentials
removeCredentials 1 param → 200
DELETE
/auth/users/tokens/{tokenOrName}
deleteAuthToken 1 param → 200

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are UserCreateRequest (9 properties), UserResponse (9 properties), PasswordPoliciesUpdateRequest (8 properties), TenantResponse (8 properties). Each schema is shown below with its type and property counts.

UserTenantsAssignmentsUpdateRequest
object
2 properties 2 required
ListPageResponseRoleDetails
object
2 properties 2 required
RoleUpdateRequest
object
5 properties 5 required
PasswordPolicyUpdateRequest
object
1 property 1 required
OIDCIdentityProviderCreateRequest
object
5 properties 5 required
UserResponse
object
9 properties 6 required
UserListResponse
object
2 properties 2 required
TenantResponse
object
8 properties 7 required
RoleResponse
object
7 properties 7 required
TenantUpdateRequest
object
2 properties 2 required
UserDataAccessResponse
object
4 properties 4 required
AuthTokenResponse
object
5 properties 3 required
PasswordPoliciesUpdateRequest
object
8 properties
UserCreateRequest
object
9 properties 3 required
UserDataSecurityMaskRequest
object
3 properties 3 required
UserRolesUpdateRequest
object
2 properties 2 required
CredentialResponse
object
5 properties 5 required
PasswordPolicyResponse
object
1 property 1 required
BasicUserResponse
object
4 properties 2 required
RoleCreateRequest
object
3 properties 3 required
UserDataAccessRequest
object
2 properties 2 required
RoleListResponse
object
2 properties 2 required
IdentityProviderResponse
object
7 properties 7 required
PasswordPolicies
object
8 properties 8 required
TenantListResponse
object
2 properties 2 required
AuthTokenCreateRequest
object
4 properties 4 required
PatchTenantRoleReq
object
4 properties 3 required
UserUpdateRequest
object
6 properties 3 required
UserDataAccessControlMaskResponse
object
4 properties 4 required
SAMLIdentityProviderCreateRequest
object
3 properties 3 required
CreateTenantRoleReq
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

socotra-auth-api-openapi.yml Raw ↑

Other APIs Socotra publishes across the network.

Socotra Auxdata API
AE Profile APIs.io
Socotra Billing API
AE Profile APIs.io
Socotra Business Stats API
AE Profile APIs.io
Socotra Claim API
AE Profile APIs.io
Socotra Compliance API
AE Profile APIs.io
Socotra Config API
AE Profile APIs.io
Socotra Contact API
AE Profile APIs.io
Socotra Document API
AE Profile APIs.io
Socotra Event API
AE Profile APIs.io
Socotra Migration API
AE Profile APIs.io
Socotra Payment Execution API
AE Profile APIs.io
Socotra Plugin API
AE Profile APIs.io
#Authentication
← Back to S APIs
API Details
ID
socotra:socotra-auth-api
Base URL
https://api.sandbox.socotra.com
Docs
https://docs.socotra.com/docs/api
Provider
Socotra
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=socotra-auth-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/socotra-auth-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Socotra 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.