Jump to

• Request
• Response

(Preview) Get list of user settings by type or default status

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/userSettings

(Preview) Returns a list of all user-specific configurations, with filters for setting type, default flag, and pagination when needed.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.

Query Parameters

• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A filter to return only resources that match the given display name exactly.
• isDefault: boolean
  A filter to return only resources that are default.

  Default Value: false
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

  Default Value: 100
• page: string
  Minimum Length: 1

  For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• settingType: string
  A filter to return only those settings whose value matches the given data type.

  Default Value: false

  Allowed Values: [ "IAM_USER_CREDENTIAL", "GIT_ACCOUNT" ]
• sortBy: string
  The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending.

  Default Value: timeCreated

  Allowed Values: [ "timeCreated", "displayName" ]
• sortOrder: string
  The sort order to use, either ascending (`ASC`) or descending (`DESC`).

  Allowed Values: [ "ASC", "DESC" ]

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. List of user settings is retrieved.

Headers

• opc-next-page: string
  For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : UserSettingCollection

Type: object

Result of listing settings.

Show Source

• items(required): array items
  List of settings.

{
    "type":"object",
    "description":"Result of listing settings.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of settings.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserSettingSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of settings.

Show Source

• Array of: object UserSettingSummary
  Summary of user settings.

{
    "description":"List of settings.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserSettingSummary"
    }
}

Nested Schema : UserSettingSummary

Type: object

Summary of user settings.

Show Source

• isDefault(required): boolean
  Default Value: false

  Indicates whether this setting is the default.
• key(required): string
  The unique identifier for the setting.
• name(required): string
  A user-friendly name for the setting.
• properties: object properties
  Additional Properties Allowed: additionalProperties

  A generic property bag associated with the setting resource.
• timeCreated(required): string(date-time)
  The date and time when the setting was created.
• timeUpdated(required): string(date-time)
  The date and time when the setting was most recently updated.
• type(required): string
  Allowed Values: [ "IAM_USER_CREDENTIAL", "GIT_ACCOUNT", "OAUTH" ]

  Setting data type discriminator

{
    "type":"object",
    "description":"Summary of user settings.",
    "required":[
        "key",
        "name",
        "type",
        "isDefault",
        "timeCreated",
        "timeUpdated"
    ],
    "properties":{
        "key":{
            "type":"string",
            "description":"The unique identifier for the setting."
        },
        "name":{
            "type":"string",
            "description":"A user-friendly name for the setting."
        },
        "type":{
            "description":"Setting data type discriminator",
            "type":"string",
            "enum":[
                "IAM_USER_CREDENTIAL",
                "GIT_ACCOUNT",
                "OAUTH"
            ],
            "x-obmcs-top-level-enum":"#/definitions/SettingType"
        },
        "isDefault":{
            "type":"boolean",
            "description":"Indicates whether this setting is the default.",
            "default":false
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the setting was created."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the setting was most recently updated."
        },
        "properties":{
            "description":"A generic property bag associated with the setting resource.",
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        }
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "description":"A generic property bag associated with the setting resource.",
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

A generic property bag associated with the setting resource.

Nested Schema : additionalProperties

Type: object

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top