📐 Identity schemas

identityIdPathParameter is a reusable OpenAPIParameter; the other seven exports are withSchema(...) SDK composers. They define request contracts for Identity features and routes, plus Profile’s identity-profile lookup.

Inventory

Export	Request location	Contract
identityIdPathParameter	Path	Required string identityId reusable parameter.
getIdentitySchema	Path	Required identityId.
findIdentitySchema	Query	Optional name, page, and limit.
updateIdentitySchema	Path, body	Required identityId; required strict JSON object with optional update fields.
deleteIdentitySchema	Path	Required identityId.
lockIdentitySchema	Path	Required identityId.
unlockIdentitySchema	Path	Required identityId.
findByIdentityIdSchema	Path, Query	Required identityId, plus optional pagination query fields.

Details

identityIdPathParameter

Definition

Reusable path-parameter definition for an identity ID.

Location	Field	Type	Required	Constraints
Path	identityId	string	Yes	No format or pattern restriction is declared.

Used by getIdentitySchema, updateIdentitySchema, deleteIdentitySchema, lockIdentitySchema, unlockIdentitySchema, and findByIdentityIdSchema. Notification also spreads it into updateNotificationToReadBatchSchema.

View complete source

export const identityIdPathParameter: OpenAPIParameter = {
  in: 'path',
  name: 'identityId',
  required: true,
  schema: {
    type: 'string',
  },
};

---

getIdentitySchema

Definition

Validates the path ID for identity retrieval.

Location	Field	Type	Required	Constraints
Path	identityId	string	Yes	Spread from identityIdPathParameter.

Used by route: getIdentityRoute. Used by feature: getIdentityFeature.

View complete source

export const getIdentitySchema = withSchema({
  parameters: [{...identityIdPathParameter}],
});

---

findIdentitySchema

Definition

Validates the identity-list query. page and limit are spread from the shared paginationQueryParametersSchema.

Location	Field	Type	Required	Constraints
Query	name	string	No	Optional identity-name filter.
Query	page	integer	No	Minimum 1; maximum 1000.
Query	limit	integer	No	Minimum 1; maximum 50.

Used by route: findIdentitiesRoute. Used by feature: findIdentitiesFeature.

View complete source

export const findIdentitySchema = withSchema({
  parameters: [
    {
      in: 'query',
      name: 'name',
      required: false,
      schema: {
        type: 'string',
      },
    },
    ...paginationQueryParametersSchema,
  ],
});

---

updateIdentitySchema

Definition

Validates an identity update. The request body is required and only accepts the listed JSON properties; no body property is individually required.

Location	Field	Type	Required	Constraints
Path	identityId	string	Yes	Spread from identityIdPathParameter.
Body	body	object	Yes	Content type application/json; additionalProperties: false.
Body	email	string	No	Permitted JSON property.
Body	emailVerified	boolean	No	Permitted JSON property.
Body	typeId	string	No	Permitted JSON property.

Used by route: updateIdentityRoute. Used by feature: updateIdentityFeature.

View complete source

export const updateIdentitySchema = withSchema({
  parameters: [{...identityIdPathParameter}],
  requestBody: {
    content: {
      'application/json': {
        schema: {
          $schema: 'http://json-schema.org/draft-07/schema#',
          additionalProperties: false,
          properties: {
            email: {type: 'string'},
            emailVerified: {type: 'boolean'},
            typeId: {type: 'string'},
          },
          type: 'object',
        },
      },
    },
    required: true,
  },
});

---

deleteIdentitySchema

Definition

Validates the path ID for identity deletion.

Location	Field	Type	Required	Constraints
Path	identityId	string	Yes	Spread from identityIdPathParameter.

Used by route: deleteIdentityRoute. Used by feature: deleteIdentityFeature.

View complete source

export const deleteIdentitySchema = withSchema({
  parameters: [{...identityIdPathParameter}],
});

---

lockIdentitySchema

Definition

Validates the path ID for identity locking.

Location	Field	Type	Required	Constraints
Path	identityId	string	Yes	Spread from identityIdPathParameter.

Used by route: lockIdentityRoute. Used by feature: lockIdentityFeature.

View complete source

export const lockIdentitySchema = withSchema({
  parameters: [{...identityIdPathParameter}],
});

---

unlockIdentitySchema

Definition

Validates the path ID for identity unlocking.

Location	Field	Type	Required	Constraints
Path	identityId	string	Yes	Spread from identityIdPathParameter.

Used by route: unlockIdentityRoute. Used by feature: unlockIdentityFeature.

View complete source

export const unlockIdentitySchema = withSchema({
  parameters: [{...identityIdPathParameter}],
});

---

findByIdentityIdSchema

Definition

Validates Profile’s identity-profile lookup. Its pagination fields are spread from the shared paginationQueryParametersSchema.

Location	Field	Type	Required	Constraints
Path	identityId	string	Yes	Spread from identityIdPathParameter.
Query	page	integer	No	Minimum 1; maximum 1000.
Query	limit	integer	No	Minimum 1; maximum 50.

Used by route: findProfilesByIdentityIdRoute. Used by feature: findProfilesByIdentityIdFeature.

View complete source

export const findByIdentityIdSchema = withSchema({
  parameters: [{...identityIdPathParameter}, ...paginationQueryParametersSchema],
});

---