UserCredential

UserCredential 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
id	string <uuid>	Unique id string for this User Credential
identity_id	string <uuid>	Globus Auth identity id that this credential is associated with.
connector_id	string <uuid>	Connector that this credential is used 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.
display_name	string	Display name of the credential.
storage_gateway_id	string	Storage Gateway this credential is associated with.
home_directory	string	The home directory of this account associated with this credential.[Private]
invalid	boolean	Flag indicating that this credential is no longer valid.
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.
policies	One of { object AzureBlobUserCredentialPolicies , BlackPearlUserCredentialPolicies , object BoxUserCredentialPolicies , object CephUserCredentialPolicies , object GoogleDriveUserCredentialPolicies , GoogleCloudStorageUserCredentialPolicies , object HpssUserCredentialPolicies , IrodsUserCredentialPolicies , object OneDriveUserCredentialPolicies , PosixUserCredentialPolicies , PosixStagingUserCredentialPolicies , object S3UserCredential , object }	Connector-specific user credential policies.

{
  "DATA_TYPE": "user_credential#1.0.0",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "identity_id": "c8b7ab5c-595c-43c9-8e43-9e8a3debfe4c",
  "connector_id": "145812c8-decc-41f1-83cf-bb2a85a2a70b",
  "username": "testuser",
  "display_name": "Test User",
  "storage_gateway_id": "fc1f3ba0-1fa4-42b2-8bb3-53983774fa5f",
  "home_directory": "/home/user",
  "invalid": true,
  "provisioned": true,
  "policies": {
    "DATA_TYPE": "azure_blob_user_credential_policies#1.0.0",
    "sub": "string",
    "email": "user@example.com",
    "access_token": "string",
    "refresh_token": "string",
    "scopes": [
      "openid",
      "email",
      "profile",
      "offline_access",
      "user_impersonation"
    ],
    "token_expiry": "2020-02-04T21:44:12Z"
  }
}