Jump to

• Request
• Response

ListUsers

get

/20160918/users

List the users in your tenancy. Specify the OCID of your tenancy for the value of the compartment OCID.

Request

Supported Media Types

• application/json

Query Parameters

• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment.
• externalIdentifier: string
  Minimum Length: 1

  Maximum Length: 255

  The id of a user in the identity provider.
• identityProviderId: string
  Minimum Length: 1

  Maximum Length: 255

  The id of the identity provider.
• lifecycleState: string
  A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
• 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. 1 is the minimum, 1000 is the maximum.

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

  Maximum Length: 255

  A filter to only return resources that match the given name exactly.
• page: string
  Minimum Length: 1

  Maximum Length: 512

  For list pagination. The value of the opc-next-page response header from the previous List call.

  Default Value: oracle.doceng.json.BetterJsonNull@2c07545f
• sortBy: string
  The optional field to sort the results by.

  Default Value: NAME

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

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

The list is being retrieved.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object User
  An individual employee or system that needs to manage or use your company's Oracle Private Cloud Appliance resources. Users might need to launch instances, manage remote disks, work with your cloud network, etc. Users have one or more IAM Service credentials (ApiKey, UIPassword, SwiftPassword and AuthToken). End users of your application are not typically IAM Service users, but for tenancies that have identity domains, they might be. These users are created directly within the Oracle Private Cloud Appliance system, via the IAM service. They are different from federated users, who authenticate themselves to the Compute Web UI via an identity provider. Avoid entering confidential information when you supply string values using the API.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/User"
    }
}

Nested Schema : User

Type: object

An individual employee or system that needs to manage or use your company's Oracle Private Cloud Appliance resources. Users might need to launch instances, manage remote disks, work with your cloud network, etc. Users have one or more IAM Service credentials (ApiKey, UIPassword, SwiftPassword and AuthToken). End users of your application are not typically IAM Service users, but for tenancies that have identity domains, they might be. These users are created directly within the Oracle Private Cloud Appliance system, via the IAM service. They are different from federated users, who authenticate themselves to the Compute Web UI via an identity provider. Avoid entering confidential information when you supply string values using the API.

Show Source

• capabilities: object UserCapabilities
  Properties indicating how the user is allowed to authenticate.
• compartmentId(required): string
  The OCID of the tenancy containing the user.
• dbUserName: string
  Minimum Length: 0

  Maximum Length: 201

  DB username of the DB credential. Has to be unique across the tenancy.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
• description(required): string
  Minimum Length: 1

  Maximum Length: 400

  The description you assign to the user. Does not need to be unique, and it is changeable. (For tenancies that support identity domains) You can have an empty description.
• email: string
  Minimum Length: 0

  Maximum Length: 254

  The email address you assign to the user. The email address must be unique across all users in the tenancy. (For tenancies that support identity domains) The email address is required unless the requirement is disabled at the tenancy level.
• emailVerified: boolean
  Whether the email address has been validated.
• externalIdentifier: string
  Identifier of the user in the identity provider
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
• id(required): string
  The OCID of the user.
• identityProviderId: string
  The OCID of the IdentityProvider this user belongs to.
• inactiveStatus: integer(int64)
  Returned only if the user's lifecycleState is INACTIVE. A 16-bit value showing the reason why the user is inactive: - bit 0: SUSPENDED (reserved for future use) - bit 1: DISABLED (reserved for future use) - bit 2: BLOCKED (the user has exceeded the maximum number of failed login attempts for the Compute Web UI)
• isMfaActivated(required): boolean
  Flag indicates if MFA has been activated for the user.
• lastSuccessfulLoginTime: string(date-time)
  The date and time of when the user most recently logged in the format defined by RFC3339 (ex. 2016-08-25T21:10:29.600Z). If there is no login history, this field is null. For illustrative purposes, suppose we have a user who has logged in at July 1st, 2020 at 1200 PST and logged out 30 minutes later. They then login again on July 2nd, 2020 at 1500 PST. Their previousSuccessfulLoginTime would be 2020-07-01:19:00.000Z. Their lastSuccessfulLoginTime would be 2020-07-02:22:00.000Z.
• lifecycleState(required): string
  Minimum Length: 1

  Maximum Length: 64

  Allowed Values: [ "CREATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED" ]

  The user's current state. After creating a user, make sure its lifecycleState changes from CREATING to ACTIVE before using it.
• name(required): string
  Minimum Length: 1

  Maximum Length: 100

  The name you assign to the user during creation. This is the user's login for the Compute Web UI. The name must be unique across all users in the tenancy and cannot be changed.
• previousSuccessfulLoginTime: string(date-time)
  The date and time of when the user most recently logged in the format defined by RFC3339 (ex. 2016-08-25T21:10:29.600Z). If there is no login history, this field is null. For illustrative purposes, suppose we have a user who has logged in at July 1st, 2020 at 1200 PST and logged out 30 minutes later. They then login again on July 2nd, 2020 at 1500 PST. Their previousSuccessfulLoginTime would be 2020-07-01:19:00.000Z. Their lastSuccessfulLoginTime would be 2020-07-02:22:00.000Z.
• timeCreated(required): string(date-time)
  Date and time the user was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
• userSupportAccounts: object SupportAccounts
  The support accounts that an OCI user can links to. An OCI user may links to different SupportAccounts from different support provider. The OCI user can only link to one support account from a a particular support provider.

{
    "description":"An individual employee or system that needs to manage or use your company's Oracle Private Cloud Appliance resources. Users might need to launch instances, manage remote disks, work with your cloud network, etc. Users have one or more IAM Service credentials (ApiKey, UIPassword, SwiftPassword and AuthToken). End users of your application are not typically IAM Service users, but for tenancies that have identity domains, they might be. These users are created directly within the Oracle Private Cloud Appliance system, via the IAM service. They are different from federated users, who authenticate themselves to the Compute Web UI via an identity provider. Avoid entering confidential information when you supply string values using the API.",
    "required":[
        "id",
        "compartmentId",
        "name",
        "description",
        "timeCreated",
        "lifecycleState",
        "isMfaActivated"
    ],
    "x-obmcs-splat":{
        "resourceKind":"user",
        "adLocality":"regional"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The OCID of the user."
        },
        "compartmentId":{
            "type":"string",
            "description":"The OCID of the tenancy containing the user."
        },
        "name":{
            "type":"string",
            "description":"The name you assign to the user during creation. This is the user's login for the Compute Web UI. The name must be unique across all users in the tenancy and cannot be changed.",
            "minLength":"1",
            "maxLength":"100"
        },
        "description":{
            "type":"string",
            "description":"The description you assign to the user. Does not need to be unique, and it is changeable. (For tenancies that support identity domains) You can have an empty description.",
            "minLength":"1",
            "maxLength":"400"
        },
        "email":{
            "type":"string",
            "description":"The email address you assign to the user. The email address must be unique across all users in the tenancy. (For tenancies that support identity domains) The email address is required unless the requirement is disabled at the tenancy level.",
            "minLength":"0",
            "maxLength":"254"
        },
        "emailVerified":{
            "type":"boolean",
            "description":"Whether the email address has been validated."
        },
        "dbUserName":{
            "type":"string",
            "description":"DB username of the DB credential. Has to be unique across the tenancy.",
            "minLength":"0",
            "maxLength":"201"
        },
        "identityProviderId":{
            "type":"string",
            "description":"The OCID of the IdentityProvider this user belongs to."
        },
        "externalIdentifier":{
            "type":"string",
            "description":"Identifier of the user in the identity provider"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time the user was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z "
        },
        "lifecycleState":{
            "type":"string",
            "enum":[
                "CREATING",
                "ACTIVE",
                "INACTIVE",
                "DELETING",
                "DELETED"
            ],
            "description":"The user's current state. After creating a user, make sure its lifecycleState changes from CREATING to ACTIVE before using it.",
            "minLength":"1",
            "maxLength":"64"
        },
        "inactiveStatus":{
            "type":"integer",
            "format":"int64",
            "description":"Returned only if the user's lifecycleState is INACTIVE. A 16-bit value showing the reason why the user is inactive:  - bit 0: SUSPENDED (reserved for future use) - bit 1: DISABLED (reserved for future use) - bit 2: BLOCKED (the user has exceeded the maximum number of failed login attempts for the Compute Web UI) "
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "type":"object",
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported."
                }
            }
        },
        "capabilities":{
            "$ref":"#/definitions/UserCapabilities"
        },
        "isMfaActivated":{
            "type":"boolean",
            "description":"Flag indicates if MFA has been activated for the user."
        },
        "lastSuccessfulLoginTime":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of when the user most recently logged in the format defined by RFC3339 (ex. 2016-08-25T21:10:29.600Z). If there is no login history, this field is null. For illustrative purposes, suppose we have a user who has logged in at July 1st, 2020 at 1200 PST and logged out 30 minutes later. They then login again on July 2nd, 2020 at 1500 PST. Their previousSuccessfulLoginTime would be 2020-07-01:19:00.000Z. Their lastSuccessfulLoginTime would be 2020-07-02:22:00.000Z."
        },
        "previousSuccessfulLoginTime":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of when the user most recently logged in the format defined by RFC3339 (ex. 2016-08-25T21:10:29.600Z). If there is no login history, this field is null. For illustrative purposes, suppose we have a user who has logged in at July 1st, 2020 at 1200 PST and logged out 30 minutes later. They then login again on July 2nd, 2020 at 1500 PST. Their previousSuccessfulLoginTime would be 2020-07-01:19:00.000Z. Their lastSuccessfulLoginTime would be 2020-07-02:22:00.000Z."
        },
        "userSupportAccounts":{
            "$ref":"#/definitions/SupportAccounts"
        }
    },
    "type":"object"
}

Nested Schema : UserCapabilities

Type: object

Properties indicating how the user is allowed to authenticate.

Show Source

• canUseApiKeys: boolean
  Indicates if the user can use API keys.
• canUseAuthTokens: boolean
  Indicates if the user can use SWIFT passwords / auth tokens.
• canUseConsolePassword: boolean
  Indicates if the user can log in to the Compute Web UI.
• canUseCustomerSecretKeys: boolean
  Indicates if the user can use SigV4 symmetric keys.
• canUseDbCredentials: boolean
  Indicates if the user can use DB passwords.
• canUseOAuth2ClientCredentials: boolean
  Indicates if the user can use OAuth2 credentials and tokens.
• canUseSmtpCredentials: boolean
  Indicates if the user can use SMTP passwords.

{
    "description":"Properties indicating how the user is allowed to authenticate.",
    "properties":{
        "canUseConsolePassword":{
            "type":"boolean",
            "description":"Indicates if the user can log in to the Compute Web UI."
        },
        "canUseApiKeys":{
            "type":"boolean",
            "description":"Indicates if the user can use API keys."
        },
        "canUseAuthTokens":{
            "type":"boolean",
            "description":"Indicates if the user can use SWIFT passwords / auth tokens."
        },
        "canUseSmtpCredentials":{
            "type":"boolean",
            "description":"Indicates if the user can use SMTP passwords."
        },
        "canUseDbCredentials":{
            "type":"boolean",
            "description":"Indicates if the user can use DB passwords."
        },
        "canUseCustomerSecretKeys":{
            "type":"boolean",
            "description":"Indicates if the user can use SigV4 symmetric keys."
        },
        "canUseOAuth2ClientCredentials":{
            "type":"boolean",
            "description":"Indicates if the user can use OAuth2 credentials and tokens."
        }
    },
    "type":"object"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

{
    "type":"object",
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported."
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Nested Schema : SupportAccounts

Type: object

The support accounts that an OCI user can links to. An OCI user may links to different SupportAccounts from different support provider. The OCI user can only link to one support account from a a particular support provider.

Show Source

• mos: object MosSupportAccount
  Derived object from SupportAccount. The support provider is MOS

{
    "description":"The support accounts that an OCI user can links to. An OCI user may links to different SupportAccounts from different support provider. The OCI user can only link to one support account from a a particular support provider.",
    "properties":{
        "mos":{
            "$ref":"#/definitions/MosSupportAccount"
        }
    },
    "type":"object"
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported."
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Nested Schema : MosSupportAccount

Type: object

Derived object from SupportAccount. The support provider is MOS

Match All

Show Source

• object SupportAccount
  Discriminator: supportProvider

  This is the base object indicating who is the support provider, and what is the userId within the support provider.

{
    "description":"Derived object from SupportAccount. The support provider is MOS ",
    "allOf":[
        {
            "$ref":"#/definitions/SupportAccount"
        },
        {
            "discriminator":"MOS"
        }
    ],
    "type":"object"
}

Nested Schema : SupportAccount

Type: object

Discriminator: supportProvider

This is the base object indicating who is the support provider, and what is the userId within the support provider.

Show Source

• supportProvider(required): string
  Allowed Values: [ "MOS" ]

  The name of the support provider.
• supportUserID(required): string
  The userID used within a support provider.

{
    "description":"This is the base object indicating who is the support provider, and what is the userId within the support provider.",
    "discriminator":"supportProvider",
    "properties":{
        "supportUserID":{
            "type":"string",
            "description":"The userID used within a support provider."
        },
        "supportProvider":{
            "type":"string",
            "description":"The name of the support provider.",
            "enum":[
                "MOS"
            ]
        }
    },
    "required":[
        "supportUserID",
        "supportProvider"
    ],
    "type":"object"
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

403 Response

Forbidden

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

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

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top