Identity & Access Directory Service

OAS 3.1.0 v3.0.1 ✓ Valid 3.1

specs/identity-directory-service.json • 3 operations • 2 schemas • 0 webhooks

⬇ Download .json

Identity & Access Directory Service

Zero-trust identity provisioning, RBAC roles, and session introspection in JSON format

Manages organization members, fine-grained role assignments, and short-lived session tokens.

Configured Target Servers

/api/mock/identity-directory-service Built-in OpenAPI 3.1 Mock Server

https://httpbin.org/anything HTTPBin Live Echo Runner

Detected OpenAPI 3.1 / JSON Schema 2020-12 Features

✦ info.summary✦ SPDX license.identifier✦ schema examples array✦ type array unions (e.g. ["string", "null"])

Users

GET /v1/users List directory users

Request Parameters

Name	In	Type (OAS 3.1)	Required
`department`	query	`string`	Optional

Responses

200 Directory user list

{
  "users": [
    {
      "id": "usr_77210a",
      "email": "ada@example.com",
      "displayName": "Ada Lovelace",
      "roles": [
        "platform-admin",
        "billing-viewer"
      ],
      "mfaEnabled": true
    }
  ]
}

POST /v1/users Invite user to organization

Request Body (application/json)

{
  "email": "grace@example.com",
  "displayName": "Grace Hopper",
  "roles": [
    "developer"
  ]
}

Responses

201 User invitation created

{
  "id": "usr_77210a",
  "email": "ada@example.com",
  "displayName": "Ada Lovelace",
  "roles": [
    "platform-admin",
    "billing-viewer"
  ],
  "mfaEnabled": true
}

Roles

PUT /v1/users/{userId}/roles Replace RBAC roles for a user

Request Parameters

Name	In	Type (OAS 3.1)	Required
`userId`	path	`string`	Yes

Request Body (application/json)

{
  "roles": [
    "admin",
    "spec-editor"
  ],
  "expiresAt": "2027-01-01T00:00:00Z"
}

Responses

200 Updated role bindings

{
  "id": "usr_77210a",
  "email": "ada@example.com",
  "displayName": "Ada Lovelace",
  "roles": [
    "platform-admin",
    "billing-viewer"
  ],
  "mfaEnabled": true
}

Component Schemas (JSON Schema 2020-12)

UserRecord

object

Property	Type	Required
`id`	`string`	✓
`email`	`string` (email)	✓
`displayName`	`string \| null`	—
`roles`	`array<string>`	✓
`mfaEnabled`	`boolean`	✓

InviteUserPayload

object

Property	Type	Required
`email`	`string` (email)	✓
`displayName`	`string \| null`	—
`roles`	`array<string>`	✓