Package com.okta.sdk.resource.api

Class SchemaApi

java.lang.Object
com.okta.sdk.resource.api.SchemaApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2026-03-13T17:36:05.533634+05:30[Asia/Kolkata]", comments="Generator version: 7.15.0") public class SchemaApi extends Object

  • Constructor Details

    • SchemaApi

      public SchemaApi()

    • SchemaApi

      public SchemaApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getApplicationUserSchema

      public UserSchema getApplicationUserSchema(String appId) throws ApiException
      Retrieve the default app user schema for an app Retrieves the default schema for an app user. The [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature does not extend to apps. All users assigned to a given app use the same app user schema. Therefore, unlike the user schema operations, the app user schema operations all specify `default` and don't accept a schema ID.
      Parameters:
      appId - Application ID (required)
      Returns:
      UserSchema
      Throws:
      ApiException - if fails to make API call

    • getApplicationUserSchema

      public UserSchema getApplicationUserSchema(String appId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve the default app user schema for an app Retrieves the default schema for an app user. The [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature does not extend to apps. All users assigned to a given app use the same app user schema. Therefore, unlike the user schema operations, the app user schema operations all specify `default` and don't accept a schema ID.
      Parameters:
      appId - Application ID (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      UserSchema
      Throws:
      ApiException - if fails to make API call

    • getGroupSchema

      public GroupSchema getGroupSchema() throws ApiException
      Retrieve the default group schema Retrieves the group schema The [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature does not extend to groups. All groups use the same group schema. Unlike user schema operations, group schema operations all specify `default` and don't accept a schema ID.
      Returns:
      GroupSchema
      Throws:
      ApiException - if fails to make API call

    • getGroupSchema

      public GroupSchema getGroupSchema(Map<String,String> additionalHeaders) throws ApiException
      Retrieve the default group schema Retrieves the group schema The [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature does not extend to groups. All groups use the same group schema. Unlike user schema operations, group schema operations all specify `default` and don't accept a schema ID.
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      GroupSchema
      Throws:
      ApiException - if fails to make API call

    • getLogStreamSchema

      public LogStreamSchema getLogStreamSchema(LogStreamType logStreamType) throws ApiException
      Retrieve the log stream schema for the schema type Retrieves the schema for a log stream type. The `logStreamType` element in the URL specifies the log stream type, which is either `aws_eventbridge` or `splunk_cloud_logstreaming`. Use the `aws_eventbridge` literal to retrieve the AWS EventBridge type schema, and use the `splunk_cloud_logstreaming` literal retrieve the Splunk Cloud type schema.
      Parameters:
      logStreamType - (required)
      Returns:
      LogStreamSchema
      Throws:
      ApiException - if fails to make API call

    • getLogStreamSchema

      public LogStreamSchema getLogStreamSchema(LogStreamType logStreamType, Map<String,String> additionalHeaders) throws ApiException
      Retrieve the log stream schema for the schema type Retrieves the schema for a log stream type. The `logStreamType` element in the URL specifies the log stream type, which is either `aws_eventbridge` or `splunk_cloud_logstreaming`. Use the `aws_eventbridge` literal to retrieve the AWS EventBridge type schema, and use the `splunk_cloud_logstreaming` literal retrieve the Splunk Cloud type schema.
      Parameters:
      logStreamType - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      LogStreamSchema
      Throws:
      ApiException - if fails to make API call

    • getUserSchema

      public UserSchema getUserSchema(String schemaId) throws ApiException
      Retrieve a user schema Retrieves the schema for a user type
      Parameters:
      schemaId - Schema ID. You can also use `default` to refer to the default user type schema. (required)
      Returns:
      UserSchema
      Throws:
      ApiException - if fails to make API call

    • getUserSchema

      public UserSchema getUserSchema(String schemaId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a user schema Retrieves the schema for a user type
      Parameters:
      schemaId - Schema ID. You can also use `default` to refer to the default user type schema. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      UserSchema
      Throws:
      ApiException - if fails to make API call

    • listLogStreamSchemas

      public List<LogStreamSchema> listLogStreamSchemas() throws ApiException
      List the log stream schemas Lists the schema for all log stream types visible for this org
      Returns:
      List<LogStreamSchema>
      Throws:
      ApiException - if fails to make API call

    • listLogStreamSchemas

      public List<LogStreamSchema> listLogStreamSchemas(Map<String,String> additionalHeaders) throws ApiException
      List the log stream schemas Lists the schema for all log stream types visible for this org
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<LogStreamSchema>
      Throws:
      ApiException - if fails to make API call

    • listLogStreamSchemasPaged

      public Iterable<LogStreamSchema> listLogStreamSchemasPaged()
      List the log stream schemas (Paginated) Lists the schema for all log stream types visible for this org This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.
      Returns:
      Iterable<LogStreamSchema> lazy iterable over all pages

    • listLogStreamSchemasPaged

      public Iterable<LogStreamSchema> listLogStreamSchemasPaged(Map<String,String> additionalHeaders)
      List the log stream schemas (Paginated with additional headers) Lists the schema for all log stream types visible for this org This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
      Parameters:
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<LogStreamSchema> lazy iterable over all pages

    • updateApplicationUserProfile

      public UserSchema updateApplicationUserProfile(String appId, UserSchema body) throws ApiException
      Update the app user profile schema for an app Updates the app user schema. This updates, adds, or removes one or more custom profile properties or the nullability of a base property in the app user schema for an app. Changing a base property's nullability (for example, the value of its `required` field) is allowed only if it is nullable in the default predefined schema for the app. > **Note:** You must set properties explicitly to `null` to remove them from the schema; otherwise, `POST` is interpreted as a partial update. The [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature does not extend to apps. All users assigned to a given app use the same app user schema. Therefore, unlike the user schema operations, the app user schema operations all specify `default` and don't accept a schema ID.
      Parameters:
      appId - Application ID (required)
      body - (optional)
      Returns:
      UserSchema
      Throws:
      ApiException - if fails to make API call

    • updateApplicationUserProfile

      public UserSchema updateApplicationUserProfile(String appId, UserSchema body, Map<String,String> additionalHeaders) throws ApiException
      Update the app user profile schema for an app Updates the app user schema. This updates, adds, or removes one or more custom profile properties or the nullability of a base property in the app user schema for an app. Changing a base property's nullability (for example, the value of its `required` field) is allowed only if it is nullable in the default predefined schema for the app. > **Note:** You must set properties explicitly to `null` to remove them from the schema; otherwise, `POST` is interpreted as a partial update. The [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature does not extend to apps. All users assigned to a given app use the same app user schema. Therefore, unlike the user schema operations, the app user schema operations all specify `default` and don't accept a schema ID.
      Parameters:
      appId - Application ID (required)
      body - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      UserSchema
      Throws:
      ApiException - if fails to make API call

    • updateGroupSchema

      public GroupSchema updateGroupSchema(GroupSchema groupSchema) throws ApiException
      Update the group profile schema Updates the group profile schema. This updates, adds, or removes one or more custom profile properties in a group schema. Currently Okta does not support changing base group profile properties. > **Note:** You must set properties explicitly to `null` to remove them from the schema; otherwise, `POST` is interpreted as a partial update. The [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature does not extend to groups. All groups use the same group schema. Unlike user schema operations, group schema operations all specify `default` and don't accept a schema ID.
      Parameters:
      groupSchema - (optional)
      Returns:
      GroupSchema
      Throws:
      ApiException - if fails to make API call

    • updateGroupSchema

      public GroupSchema updateGroupSchema(GroupSchema groupSchema, Map<String,String> additionalHeaders) throws ApiException
      Update the group profile schema Updates the group profile schema. This updates, adds, or removes one or more custom profile properties in a group schema. Currently Okta does not support changing base group profile properties. > **Note:** You must set properties explicitly to `null` to remove them from the schema; otherwise, `POST` is interpreted as a partial update. The [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature does not extend to groups. All groups use the same group schema. Unlike user schema operations, group schema operations all specify `default` and don't accept a schema ID.
      Parameters:
      groupSchema - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GroupSchema
      Throws:
      ApiException - if fails to make API call

    • updateUserProfile

      public UserSchema updateUserProfile(String schemaId, UserSchema userSchema) throws ApiException
      Update a user schema Updates a user schema. Use this request to update, add, or remove one or more profile properties in a user schema. If you specify `default` for the `schemaId`, updates will apply to the default user type. Unlike custom user profile properties, limited changes are allowed to base user profile properties (permissions, nullability of the `firstName` and `lastName` properties, or pattern for `login`). You can't remove a property from the default schema if it's being referenced as a [`matchAttribute`](/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/createIdentityProvider!path=policy/subject/matchAttribute&t=request) in `SAML2` IdPs. Currently, all validation of SAML assertions are only performed against the default user type. > **Note:** You must set properties explicitly to `null` to remove them from the schema; otherwise, `POST` is interpreted as a partial update.
      Parameters:
      schemaId - Schema ID. You can also use `default` to refer to the default user type schema. (required)
      userSchema - (required)
      Returns:
      UserSchema
      Throws:
      ApiException - if fails to make API call

    • updateUserProfile

      public UserSchema updateUserProfile(String schemaId, UserSchema userSchema, Map<String,String> additionalHeaders) throws ApiException
      Update a user schema Updates a user schema. Use this request to update, add, or remove one or more profile properties in a user schema. If you specify `default` for the `schemaId`, updates will apply to the default user type. Unlike custom user profile properties, limited changes are allowed to base user profile properties (permissions, nullability of the `firstName` and `lastName` properties, or pattern for `login`). You can't remove a property from the default schema if it's being referenced as a [`matchAttribute`](/openapi/okta-management/management/tag/IdentityProvider/#tag/IdentityProvider/operation/createIdentityProvider!path=policy/subject/matchAttribute&t=request) in `SAML2` IdPs. Currently, all validation of SAML assertions are only performed against the default user type. > **Note:** You must set properties explicitly to `null` to remove them from the schema; otherwise, `POST` is interpreted as a partial update.
      Parameters:
      schemaId - Schema ID. You can also use `default` to refer to the default user type schema. (required)
      userSchema - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      UserSchema
      Throws:
      ApiException - if fails to make API call

    • getObjectMapper

      protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()