UserCredential_1_0_0

UserCredential_1_0_0 Document

Credential information for an identity on a particular storage gateway and its related collections.

Name

Type

Description

DATA_TYPE

string user_credential#1.0.0

Type of this document

connector_id

string <uuid>

Id of the connector type used by this credential

deleted

boolean

Flag indicating that this credential has been deleted

display_name

string

Display name of the credential

home_directory

string

The home directory of this account associated with this credential[Private]

id

string <uuid>

Unique id for this user credential

identity_id

string <uuid>

Globus Auth identity id that this credential is associated with

invalid

boolean

Flag indicating that this credential is no longer valid

policies

S3UserCredentialPolicies_1_0_0 or S3UserCredentialPolicies_1_1_0 or S3UserCredentialPolicies_1_2_0 or AzureBlobUserCredentialPolicies_1_0_0 or BlackPearlUserCredentialPolicies_1_0_0 or BoxUserCredential_1_0_0 or BoxUserCredential_1_1_0 or CephUserCredentialPolicies_1_0_0 or DropboxUserCredentialPolicies_1_0_0 or GoogleCloudStorageUserCredentialPolicies_1_0_0 or GoogleDriveUserCredentialPolicies_1_0_0 or HPSSUserCredentialPolicies_1_0_0 or IrodsUserCredentialPolicies_1_0_0 or OneDriveUserCredentialPolicies_1_0_0 or PosixUserCredentialPolicies_1_0_0 or PosixStagingUserCredentialPolicies_1_0_0

Connector-specific user credential policies

provisioned

boolean

Flag indicating that this credential has been fully provisioned. If this is false and the invalid property is true, then the credential was created during login and patching it to add the missing data should be presented to the user as initializing the credential.

storage_gateway_id

string <uuid>

Storage Gateway this credential is associated with

username

string

Connector-specific username that this credential is associated with. If the connector supports identity mapping, this matches the result of the mapping applied to identity_id.

 
{
  "DATA_TYPE": "user_credential#1.0.0",
  "connector_id": "9389ba6f-3696-4571-84d4-34d588c4b109",
  "deleted": true,
  "display_name": "string",
  "home_directory": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "identity_id": "011a42b9-62d7-49eb-8328-c2e454af88a1",
  "invalid": true,
  "policies": {
    "DATA_TYPE": "s3_user_credential_policies#1.0.0",
    "s3_key_id": "string",
    "s3_secret_key": "string"
  },
  "provisioned": true,
  "storage_gateway_id": "62c250f4-af41-4074-89a9-b6aff8c56fcb",
  "username": "string"
}