Jump to

• Request
• Response

(Preview) Manage user credentials and integrations

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/userSettings

(Preview) The User Settings API allows you to manage user-specific configurations and credentials within an AI Data Platform instance. What you can do -> Store user credentials and integrations, including: -> IAM user credentials -> Git account configurations (e.g., GitHub PAT) -> Create and manage multiple settings -> Mark a setting as default for a given type -> Retrieve and filter settings by type or default status Supported setting types -> IAM_USER_CREDENTIAL ??? OCI user credentials for API access -> GIT_ACCOUNT ??? Git provider configuration (e.g., GitHub personal access token) Core operations -> Create a user setting -> List all user settings (with filtering and pagination) -> Get a specific setting by key -> Update an existing setting -> Delete a setting

Request

Path Parameters

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

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.
• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected.

Body ()

Details for the new setting.

Root Schema : CreateUserSettingDetails

Type: object

Settings details for the new user.

Match All

Settings details for the new user.

Show Source

• object CreateSettingDetails
  Details of creating setting.

{
    "type":"object",
    "description":"Settings details for the new user.",
    "allOf":[
        {
            "$ref":"#/definitions/CreateSettingDetails"
        }
    ]
}

Nested Schema : CreateSettingDetails

Type: object

Details of creating setting.

Show Source

• data(required): object SettingData
  Discriminator: type

  Setting Data
• isDefault(required): boolean
  Default Value: false

  Indicates whether this setting is the default.
• name(required): string
  A user-friendly name for the setting.

{
    "type":"object",
    "description":"Details of creating setting.",
    "required":[
        "name",
        "isDefault",
        "data"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"A user-friendly name for the setting."
        },
        "isDefault":{
            "type":"boolean",
            "description":"Indicates whether this setting is the default.",
            "default":false
        },
        "data":{
            "$ref":"#/definitions/SettingData"
        }
    }
}

Nested Schema : SettingData

Type: object

Discriminator: type

Setting Data

Show Source

• type(required): string
  Allowed Values: [ "IAM_USER_CREDENTIAL", "GIT_ACCOUNT", "OAUTH" ]

  Setting data type discriminator

{
    "type":"object",
    "description":"Setting Data",
    "discriminator":"type",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"Setting data type discriminator",
            "type":"string",
            "enum":[
                "IAM_USER_CREDENTIAL",
                "GIT_ACCOUNT",
                "OAUTH"
            ],
            "x-obmcs-top-level-enum":"#/definitions/SettingType"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. Settings are created or updated.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• 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 : UserSetting

Type: object

User Setting

Match All

User Setting

Show Source

• object Setting
  Setting details.

{
    "description":"User Setting",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/Setting"
        }
    ]
}

Nested Schema : Setting

Type: object

Setting details.

Show Source

• data: object SettingData
  Discriminator: type

  Setting Data
• 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.

{
    "type":"object",
    "description":"Setting details.",
    "required":[
        "key",
        "name",
        "isDefault"
    ],
    "properties":{
        "key":{
            "type":"string",
            "description":"The unique identifier for the setting."
        },
        "name":{
            "type":"string",
            "description":"A user-friendly name for the setting."
        },
        "isDefault":{
            "type":"boolean",
            "description":"Indicates whether this setting is the default.",
            "default":false
        },
        "data":{
            "$ref":"#/definitions/SettingData"
        }
    }
}

Nested Schema : SettingData

Type: object

Discriminator: type

Setting Data

Show Source

• type(required): string
  Allowed Values: [ "IAM_USER_CREDENTIAL", "GIT_ACCOUNT", "OAUTH" ]

  Setting data type discriminator

{
    "type":"object",
    "description":"Setting Data",
    "discriminator":"type",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"Setting data type discriminator",
            "type":"string",
            "enum":[
                "IAM_USER_CREDENTIAL",
                "GIT_ACCOUNT",
                "OAUTH"
            ],
            "x-obmcs-top-level-enum":"#/definitions/SettingType"
        }
    }
}

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"
        }
    }
}

409 Response

Conflict. Request conflicts with the current state of the resource.

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