NAV Navigation

EIM API 2010-05-08

The Elastic Identity Management (EIM) API enables you to manage identities and accesses for your resources in the 3DS OUTSCALE Cloud.
It is compliant with the Identity and Access Management (IAM) API of Amazon Web Services (AWS). See the AWS Compatibility Matrix

Authentication: About Signatures of API Requests
Throttling: If you exceed the number of identical requests allowed for a configured time period, a RequestLimitExceeded error message is returned.

Base URLs:

Terms of service Email: Support License: BSD 3 Clause

Authentication

Access Keys

CreateAccessKey

GET /CreateAccessKey

Creates a new secret access key and the corresponding access key ID for a specified user.
The created key is automatically set to Active. If you do not specify a user name, 3DS OUTSCALE determines one based on the access key ID that sent the request.

Parameters

Parameter In Type Required Description
UserName body string false The user name of the owner of the key to be created.

Body parameter

{
  "UserName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateAccessKeyResponse

Example responses

200 Response

{
  "AccessKey": {
    "AccessKeyId": "string",
    "CreateDate": "string",
    "SecretAccessKey": "string",
    "Status": "string",
    "UserName": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeleteAccessKey

GET /DeleteAccessKey

Deletes the access key associated with a specified user.
If you do not specify a user name, this action deletes the access key for the user who signs the request.

Parameters

Parameter In Type Required Description
AccessKeyId body string true The ID of the access key you want to delete.
UserName body string false The user name the access key you want to delete is associated with.

Body parameter

{
  "AccessKeyId": "string",
  "UserName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteAccessKeyResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ListAccessKeys

GET /ListAccessKeys

Returns information about the access key IDs of a specified user.
If the user does not have any access key ID, this action returns an empty list.

Parameters

Parameter In Type Required Description
Marker body string false The marker to request the next results page.
MaxItems body integer false The maximum number of items that can be returned in a single page (by default, 100).
UserName body string false The name of the user.

Body parameter

{
  "Marker": "string",
  "MaxItems": 0,
  "UserName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ListAccessKeysResponse

Example responses

200 Response

{
  "AccessKeyMetadata": [
    {
      "AccessKeyId": "string",
      "CreateDate": "string",
      "Status": "string",
      "UserName": "string"
    }
  ],
  "IsTruncated": true,
  "Marker": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

UpdateAccessKey

GET /UpdateAccessKey

Modifies the status of the specified access key from Active to Inactive, or from Inactive to Active.
The Active status means that the user the access key is associated with can use it for API calls. The Inactive status means the access key is disabled.
If you do not specify a user name, this action modifies the access key of the user who signs the request.

Parameters

Parameter In Type Required Description
AccessKeyId body string true The ID of the access key.
Status body string true The status of the access key (Active | Inactive).
UserName body string false The user name the access key you want to modify is associated with.

Body parameter

{
  "AccessKeyId": "string",
  "Status": "string",
  "UserName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UpdateAccessKeyResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

Certificates

DeleteServerCertificate

GET /DeleteServerCertificate

Deletes a specified server certificate.

Parameters

Parameter In Type Required Description
ServerCertificateName body string true The name of the server certificate you want to delete.

Body parameter

{
  "ServerCertificateName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteServerCertificateResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

GetServerCertificate

GET /GetServerCertificate

Retrieves information about a specified server certificate.

Parameters

Parameter In Type Required Description
ServerCertificateName body string true The name of the server certificate you want information about.

Body parameter

{
  "ServerCertificateName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). GetServerCertificateResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "ServerCertificate": {
    "CertificateBody": "string",
    "CertificateChain": "string",
    "ServerCertificateMetadata": {
      "Arn": "string",
      "Expiration": "string",
      "Path": "string",
      "ServerCertificateId": "string",
      "ServerCertificateName": "string",
      "UploadDate": "string"
    }
  }
}

ListServerCertificates

GET /ListServerCertificates

Lists your server certificates.

Parameters

Parameter In Type Required Description
Marker body string false The marker to request the next results page.
MaxItems body integer false The maximum number of items that can be returned in a single page (by default, 1000).
PathPrefix body string false The path prefix of the server certificates, set to a slash (/) if not specified.

Body parameter

{
  "Marker": "string",
  "MaxItems": 0,
  "PathPrefix": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ListServerCertificatesResponse

Example responses

200 Response

{
  "IsTruncated": true,
  "Marker": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "ServerCertificateMetadataList": [
    {
      "Arn": "string",
      "Expiration": "string",
      "Path": "string",
      "ServerCertificateId": "string",
      "ServerCertificateName": "string",
      "UploadDate": "string"
    }
  ]
}

UpdateServerCertificate

GET /UpdateServerCertificate

Modifies the name and/or the path of a specified server certificate.

Parameters

Parameter In Type Required Description
NewPath body string false A new path for the server certificate.
NewServerCertificateName body string false A new name for the server certificate.
ServerCertificateName body string true The name of the server certificate you want to modify.

Body parameter

{
  "NewPath": "string",
  "NewServerCertificateName": "string",
  "ServerCertificateName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UpdateServerCertificateResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

UploadServerCertificate

GET /UploadServerCertificate

Uploads a server certificate and its matching private key.
These elements can be used with other services (for example, to configure SSL termination on load balancers).
You can also specify the chain of intermediate certification authorities if your certificate is not directly signed by a root one. You can specify multiple intermediate certification authorities in the CertificateChain parameter. To do so, concatenate all certificates in the correct order (the first certificate must be the authority of your certificate, the second must the the authority of the first one, and so on).

The private key must be a RSA key in PKCS1 form. To check this, open the PEM file and ensure its header reads as follows: BEGIN RSA PRIVATE KEY.

[IMPORTANT]

This private key must not be protected by a password or a passphrase.

Parameters

Parameter In Type Required Description
CertificateBody body string true The PEM-encoded X509 certificate.
CertificateChain body string false The PEM-encoded intermediate certification authorities.
Path body string false The path to the server certificate, set to a slash (/) if not specified.
PrivateKey body string true The PEM-encoded private key matching the certificate.
ServerCertificateName body string true A unique name for the certificate.

Detailed descriptions

ServerCertificateName: A unique name for the certificate.
Constraints: 1-128 alphanumeric characters, pluses (+), equals (=), commas (,), periods (.), at signs (@), minuses (-), or underscores (_).

Body parameter

{
  "CertificateBody": "string",
  "CertificateChain": "string",
  "Path": "string",
  "PrivateKey": "string",
  "ServerCertificateName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UploadServerCertificateResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "ServerCertificateMetadata": {
    "Arn": "string",
    "Expiration": "string",
    "Path": "string",
    "ServerCertificateId": "string",
    "ServerCertificateName": "string",
    "UploadDate": "string"
  }
}

Groups

AddUserToGroup

GET /AddUserToGroup

Adds a user to a specified group.

Parameters

Parameter In Type Required Description
GroupName body string true The name of the group you want to add a user to.
UserName body string true The name of the user you want to add to the group.

Body parameter

{
  "GroupName": "string",
  "UserName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). AddUserToGroupResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

CreateGroup

GET /CreateGroup

Creates a group to which you can add EIM users.
You can also add an inline policy or attach a managed policy to the group, which is applied to all its users.

Parameters

Parameter In Type Required Description
GroupName body string true The name of the group to be created.
Path body string false The path to the group, set to a slash (/) if not specified.

Body parameter

{
  "GroupName": "string",
  "Path": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateGroupResponse

Example responses

200 Response

{
  "Group": {
    "Arn": "string",
    "CreateDate": "string",
    "GroupId": "string",
    "GroupName": "string",
    "Path": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeleteGroup

GET /DeleteGroup

Deletes a specified group.
The group must be empty of any user and must not have any attached policy.

Parameters

Parameter In Type Required Description
GroupName body string true The name of the group you want to delete.

Body parameter

{
  "GroupName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteGroupResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

GetGroup

GET /GetGroup

Retrieves the list of users that are in a specified group or lists the groups a user belongs to.

Parameters

Parameter In Type Required Description
GroupName body string false The name of the group.
Marker body string false The marker to request the next results page.
MaxItems body integer false The maximum number of items that can be returned in a single page (by default, 100).

Body parameter

{
  "GroupName": "string",
  "Marker": "string",
  "MaxItems": 0
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). GetGroupResponse

Example responses

200 Response

{
  "Group": {
    "Arn": "string",
    "CreateDate": "string",
    "GroupId": "string",
    "GroupName": "string",
    "Path": "string"
  },
  "IsTruncated": true,
  "Marker": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "Users": [
    {
      "Arn": "string",
      "CreateDate": "string",
      "PasswordLastUsed": "string",
      "Path": "string",
      "UserId": "string",
      "UserName": "string"
    }
  ]
}

ListGroups

GET /ListGroups

Lists the groups with the specified path prefix.
If you do not specify any path prefix, this action returns all the groups (or an empty list if there are none).

Parameters

Parameter In Type Required Description
PathPrefix body string false The path prefix with which you want to filter the results. If not specified, it is set to a slash (/).

Body parameter

{
  "PathPrefix": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ListGroupsResponse

Example responses

200 Response

{
  "Groups": [
    {
      "Arn": "string",
      "CreateDate": "string",
      "GroupId": "string",
      "GroupName": "string",
      "Path": "string"
    }
  ],
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ListGroupsForUser

GET /ListGroupsForUser

Lists the groups a specified user belongs to.

Parameters

Parameter In Type Required Description
Marker body string false The marker to request the next results page.
MaxItems body integer false The maximum number of items that can be returned in a single page (by default, 100).
UserName body string false The name of the user.

Body parameter

{
  "Marker": "string",
  "MaxItems": 0,
  "UserName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ListGroupsForUserResponse

Example responses

200 Response

{
  "Groups": [
    {
      "Arn": "string",
      "CreateDate": "string",
      "GroupId": "string",
      "GroupName": "string",
      "Path": "string"
    }
  ],
  "IsTruncated": true,
  "Marker": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

RemoveUserFromGroup

GET /RemoveUserFromGroup

Removes a specified user from a specified group.

Parameters

Parameter In Type Required Description
GroupName body string true The name of the group you want to remove the user from.
UserName body string true The name of the user you want to remove from the group.

Body parameter

{
  "GroupName": "string",
  "UserName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). RemoveUserFromGroupResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

UpdateGroup

GET /UpdateGroup

Modifies the name and/or the path of a specified group.

Parameters

Parameter In Type Required Description
GroupName body string true The name of the group you want to modify.
NewGroupName body string false A new name for the group.
NewPath body string false A new path for the group.

Body parameter

{
  "GroupName": "string",
  "NewGroupName": "string",
  "NewPath": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UpdateGroupResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

Policies

AttachGroupPolicy

GET /AttachGroupPolicy

Attaches a managed policy to a specific group. This policy applies to all the users contained in this group.

Parameters

Parameter In Type Required Description
GroupName body string true The friendly name given to the group you want to attach the policy to (between 1 and 128 characters).
PolicyArn body string true The unique resource identifier for the policy (between 20 and 2048 characters).

Body parameter

{
  "GroupName": "string",
  "PolicyArn": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). AttachGroupPolicyResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

AttachUserPolicy

GET /AttachUserPolicy

Attaches a managed policy to a specific user.

Parameters

Parameter In Type Required Description
PolicyArn body string true The unique resource identifier for the policy (between 20 and 2048 characters).
UserName body string true The friendly name of the user you want to attach the policy to (between 1 and 64 characters).

Body parameter

{
  "PolicyArn": "string",
  "UserName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). AttachUserPolicyResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

CreatePolicy

GET /CreatePolicy

Creates a new managed policy to apply to a user or a group.
This action creates a policy version and sets v1 as the default one.

Parameters

Parameter In Type Required Description
Description body string false A friendly description of the policy, in which you can write information about the permissions contained in the policy.
Path body string false The path to the policy.
PolicyDocument body string true The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information.
PolicyName body string true The name of the policy.

Body parameter

{
  "Description": "string",
  "Path": "string",
  "PolicyDocument": "string",
  "PolicyName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreatePolicyResponse

Example responses

200 Response

{
  "Policy": {
    "Arn": "string",
    "AttachmentCount": 0,
    "CreateDate": "string",
    "DefaultVersionId": "string",
    "Description": "string",
    "IsAttachable": true,
    "Path": "string",
    "PolicyId": "string",
    "PolicyName": "string",
    "UpdateDate": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

CreatePolicyVersion

GET /CreatePolicyVersion

Creates a new version of a specified managed policy.
A managed policy can have up to five versions.

Parameters

Parameter In Type Required Description
PolicyArn body string true The Outscale Resource Name (ORN) of the policy. For more information, see Resource Identifiers.
PolicyDocument body string true The policy document, corresponding to a JSON string that contains the new version of the policy. For more information, see EIM Reference Information.
SetAsDefault body boolean false If set to true, the new policy version is the default version and becomes the operative one.

Body parameter

{
  "PolicyArn": "string",
  "PolicyDocument": "string",
  "SetAsDefault": true
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreatePolicyVersionResponse

Example responses

200 Response

{
  "PolicyVersion": {
    "CreateDate": "string",
    "Document": "string",
    "IsDefaultVersion": true,
    "VersionId": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeleteGroupPolicy

GET /DeleteGroupPolicy

Deletes a specified inline policy from a specific group.

Parameters

Parameter In Type Required Description
GroupName body string true The friendly name of the group (between 1 and 128 characters).
PolicyName body string true The name of the policy document you want to delete (between 1 and 128 characters).

Body parameter

{
  "GroupName": "string",
  "PolicyName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteGroupPolicyResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeletePolicy

GET /DeletePolicy

Deletes a managed policy.
Before removing a managed policy, you must detach all users or groups attached to it and remove all the versions of the policy using the DeletePolicyVersion method.

Parameters

Parameter In Type Required Description
PolicyArn body string true The unique resource identifier of the policy you want to delete.

Body parameter

{
  "PolicyArn": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeletePolicyResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeletePolicyVersion

GET /DeletePolicyVersion

Deletes a specified version of a managed policy, if it not set as the default one.

Parameters

Parameter In Type Required Description
PolicyArn body string false The unique identifier (ARN) of the policy.
VersionId body string false The ID of the version.

Body parameter

{
  "PolicyArn": "string",
  "VersionId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeletePolicyVersionResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeleteUserPolicy

GET /DeleteUserPolicy

Deletes a specified inline policy from a specific user.

Parameters

Parameter In Type Required Description
PolicyName body string true The name of the policy document you want to delete (between 1 and 128 characters).
UserName body string true The friendly name of the user (between 1 and 64 characters).

Body parameter

{
  "PolicyName": "string",
  "UserName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteUserPolicyResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DetachGroupPolicy

GET /DetachGroupPolicy

Removes a managed policy from a specific group.

Parameters

Parameter In Type Required Description
GroupName body string true The friendly name of the group you want to detach the policy from (length between 1 and 128).
PolicyArn body string true The unique resource identifier for the policy (between 20 and 2048 characters).

Body parameter

{
  "GroupName": "string",
  "PolicyArn": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DetachGroupPolicyResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DetachUserPolicy

GET /DetachUserPolicy

Removes a managed policy from a specific user.

Parameters

Parameter In Type Required Description
PolicyArn body string true The unique resource identifier for the policy (between 20 and 2048 characters).
UserName body string true The friendly name of the user you want to detach the policy from (length between 1 and 64).

Body parameter

{
  "PolicyArn": "string",
  "UserName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DetachUserPolicyResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

GetGroupPolicy

GET /GetGroupPolicy

Returns information about an inline policy included in a specified group.

Parameters

Parameter In Type Required Description
GroupName body string true The name of the group (between 1 and 128 characters).
PolicyName body string true The name of the policy (between 1 and 128 characters).

Body parameter

{
  "GroupName": "string",
  "PolicyName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). GetGroupPolicyResponse

Example responses

200 Response

{
  "GroupName": "string",
  "PolicyDocument": "string",
  "PolicyName": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

GetPolicy

GET /GetPolicy

Retrieves information about a specified managed policy (default version, users or groups the policy is attached to). To get information about inline policies, use the GetUserPolicy and GetGroupPolicy methods.

Parameters

Parameter In Type Required Description
PolicyArn body string true The unique ressource identifier for the policy.

Body parameter

{
  "PolicyArn": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). GetPolicyResponse

Example responses

200 Response

{
  "Policy": {
    "Arn": "string",
    "AttachmentCount": 0,
    "CreateDate": "string",
    "DefaultVersionId": "string",
    "Description": "string",
    "IsAttachable": true,
    "Path": "string",
    "PolicyId": "string",
    "PolicyName": "string",
    "UpdateDate": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

GetPolicyVersion

GET /GetPolicyVersion

Gets information about a specified version of a managed policy.

Parameters

Parameter In Type Required Description
PolicyArn body string false The unique identifier (ARN) of the policy.
VersionId body string false The ID of the version.

Body parameter

{
  "PolicyArn": "string",
  "VersionId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). GetPolicyVersionResponse

Example responses

200 Response

{
  "PolicyVersion": {
    "CreateDate": "string",
    "Document": "string",
    "IsDefaultVersion": true,
    "VersionId": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

GetUserPolicy

GET /GetUserPolicy

Returns information about an inline policy included in a specified user.

Parameters

Parameter In Type Required Description
PolicyName body string true The name of the policy (between 1 and 128 characters).
UserName body string true The name of the user (between 1 and 64 characters).

Body parameter

{
  "PolicyName": "string",
  "UserName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). GetUserPolicyResponse

Example responses

200 Response

{
  "PolicyDocument": "string",
  "PolicyName": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "UserName": "string"
}

ListAttachedGroupPolicies

GET /ListAttachedGroupPolicies

Lists the managed policies attached to a specified group.

Parameters

Parameter In Type Required Description
GroupName body string true The name of the group.
Marker body string false The marker to request the next results page.
MaxItems body integer false The maximum number of items that can be returned in a single page (by default, 100).
PathPrefix body string false The path prefix of the policies, set to a slash (/) if not specified..

Body parameter

{
  "GroupName": "string",
  "Marker": "string",
  "MaxItems": 0,
  "PathPrefix": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ListAttachedGroupPoliciesResponse

Example responses

200 Response

{
  "AttachedPolicies": [
    {
      "PolicyArn": "string",
      "PolicyName": "string"
    }
  ],
  "IsTruncated": true,
  "Marker": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ListAttachedUserPolicies

GET /ListAttachedUserPolicies

Lists the managed policies attached to a specified user.

Parameters

Parameter In Type Required Description
Marker body string false The marker to request the next results page.
MaxItems body integer false The maximum number of items that can be returned in a single page (by default, 100).
PathPrefix body string false The path prefix of the policies, set to a slash (/) if not specified..
UserName body string true The name of the user.

Body parameter

{
  "Marker": "string",
  "MaxItems": 0,
  "PathPrefix": "string",
  "UserName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ListAttachedUserPoliciesResponse

Example responses

200 Response

{
  "AttachedPolicies": [
    {
      "PolicyArn": "string",
      "PolicyName": "string"
    }
  ],
  "IsTruncated": true,
  "Marker": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ListGroupPolicies

GET /ListGroupPolicies

Lists the names of the inline policies embedded in a specific group.

Parameters

Parameter In Type Required Description
GroupName body string false The name of the group.
Marker body string false The marker to request the next results page.
MaxItems body integer false The maximum number of items that can be returned in a single page (by default, 100).

Body parameter

{
  "GroupName": "string",
  "Marker": "string",
  "MaxItems": 0
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ListGroupPoliciesResponse

Example responses

200 Response

{
  "IsTruncated": true,
  "Marker": "string",
  "PolicyNames": [
    "string"
  ],
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ListPolicies

GET /ListPolicies

Lists all the managed policies available for your account.

Parameters

Parameter In Type Required Description
Marker body string false The marker to request the next results page.
MaxItems body integer false The maximum number of items that can be returned in a single page (by default, 100).
OnlyAttached body boolean false If set to true, lists only the policies attached to a user or a group.
PathPrefix body string false The path prefix you can use to filter the results, set to a slash (/) by default.
Scope body string false The scope to filter policies (ALL | OWS | local).

Body parameter

{
  "Marker": "string",
  "MaxItems": 0,
  "OnlyAttached": true,
  "PathPrefix": "string",
  "Scope": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ListPoliciesResponse

Example responses

200 Response

{
  "IsTruncated": true,
  "Marker": "string",
  "Policies": [
    {
      "Arn": "string",
      "AttachmentCount": 0,
      "CreateDate": "string",
      "DefaultVersionId": "string",
      "Description": "string",
      "IsAttachable": true,
      "Path": "string",
      "PolicyId": "string",
      "PolicyName": "string",
      "UpdateDate": "string"
    }
  ],
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ListPolicyVersions

GET /ListPolicyVersions

Lists information about all the policy versions of a specified managed policy.

Parameters

Parameter In Type Required Description
Marker body string false The marker to request the next results page.
MaxItems body integer false The maximum number of items that can be returned in a single page (by default, 100).
PolicyArn body string true The Outscale Resource Name (ORN) of the policy.

Body parameter

{
  "Marker": "string",
  "MaxItems": 0,
  "PolicyArn": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ListPolicyVersionsResponse

Example responses

200 Response

{
  "IsTruncated": true,
  "Marker": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "Versions": [
    {
      "CreateDate": "string",
      "Document": "string",
      "IsDefaultVersion": true,
      "VersionId": "string"
    }
  ]
}

ListUserPolicies

GET /ListUserPolicies

Lists the names of inline policies included in a specified user.

Parameters

Parameter In Type Required Description
Marker body string false The marker to request the next results page.
MaxItems body integer false The maximum number of items that can be returned in a single page (by default, 100).
UserName body string false The name of the user.

Body parameter

{
  "Marker": "string",
  "MaxItems": 0,
  "UserName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ListUserPoliciesResponse

Example responses

200 Response

{
  "IsTruncated": true,
  "Marker": "string",
  "PolicyNames": [
    "string"
  ],
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

PutGroupPolicy

GET /PutGroupPolicy

Creates or updates an inline policy included in a specified group.
The policy is automatically applied to all the users of the group after its creation.

Parameters

Parameter In Type Required Description
GroupName body string true The name of the group.
PolicyDocument body string true The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information.
PolicyName body string true The name of the policy.

Body parameter

{
  "GroupName": "string",
  "PolicyDocument": "string",
  "PolicyName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). PutGroupPolicyResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

PutUserPolicy

GET /PutUserPolicy

Creates or updates an inline policy included in a specified user.
The policy is automatically applied to the user after its creation.

Parameters

Parameter In Type Required Description
PolicyDocument body string true The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information.
PolicyName body string true The name of the policy.
UserName body string true The name of the user.

Body parameter

{
  "PolicyDocument": "string",
  "PolicyName": "string",
  "UserName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). PutUserPolicyResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

SetDefaultPolicyVersion

GET /SetDefaultPolicyVersion

Sets a specified version of a managed policy as the default (operative) one.
You can modify the default version of a policy at any time.

Parameters

Parameter In Type Required Description
PolicyArn body string false The unique identifier (ARN) of the policy.
VersionId body string false The ID of the version.

Body parameter

{
  "PolicyArn": "string",
  "VersionId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). SetDefaultPolicyVersionResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

Users

CreateUser

GET /CreateUser

Creates a new user for your account.

Parameters

Parameter In Type Required Description
Path body string false The path for the user name. If you do not specify a path, it is set to a slash (/).
UserName body string true The name of the user to be created.

Body parameter

{
  "Path": "string",
  "UserName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateUserResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "User": {
    "Arn": "string",
    "CreateDate": "string",
    "PasswordLastUsed": "string",
    "Path": "string",
    "UserId": "string",
    "UserName": "string"
  }
}

DeleteUser

GET /DeleteUser

Deletes a specified user. The user must not belong to any group and have any key, signing certificate or attached policy.

Parameters

Parameter In Type Required Description
UserName body string true The name of the user you want to delete.

Body parameter

{
  "UserName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteUserResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

GetUser

GET /GetUser

Gets information about a specified user, including its creation date, path, unique ID and Outscale Resource Name (ORN).
If you do not specify a user name, this action returns information about the user who sent the request.

Parameters

Parameter In Type Required Description
UserName body string false The name of the user.

Body parameter

{
  "UserName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). GetUserResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "User": {
    "Arn": "string",
    "CreateDate": "string",
    "PasswordLastUsed": "string",
    "Path": "string",
    "UserId": "string",
    "UserName": "string"
  }
}

ListUsers

GET /ListUsers

Lists all users that have a specified path prefix.
If you do not specify a path prefix, this action returns a list of all users in the account (or an empty list if there are none).

Parameters

Parameter In Type Required Description
Marker body string false The marker to request the next results page.
MaxItems body integer false The maximum number of items that can be returned in a single page (by default, 100).
PathPrefix body string false The path prefix.

Body parameter

{
  "Marker": "string",
  "MaxItems": 0,
  "PathPrefix": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ListUsersResponse

Example responses

200 Response

{
  "IsTruncated": true,
  "Marker": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "Users": [
    {
      "Arn": "string",
      "CreateDate": "string",
      "PasswordLastUsed": "string",
      "Path": "string",
      "UserId": "string",
      "UserName": "string"
    }
  ]
}

UpdateUser

GET /UpdateUser

Modifies the name and/or the path of a specified user.

Parameters

Parameter In Type Required Description
NewPath body string false A new path for the user.
NewUserName body string false A new name for the user.
UserName body string true The name of the user you want to modify.

Body parameter

{
  "NewPath": "string",
  "NewUserName": "string",
  "UserName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UpdateUserResponse

Example responses

200 Response

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

Schemas

AccessKey

Information about the access key, in an XML file.

Properties

Name Type Required Restrictions Description
AccessKeyId string false none The ID of the access key.
CreateDate string false none The date of the creation of the access key.
SecretAccessKey string false none The secret key that enables you to send requests.
Status string false none The state of the access key (Active if the key is valid for API calls, or Inactive if not).
UserName string false none The account name of the user the access key is associated with.

Schema

{
  "AccessKeyId": "string",
  "CreateDate": "string",
  "SecretAccessKey": "string",
  "Status": "string",
  "UserName": "string"
}

AccessKeyMetadata

A list of access keys and their metadata.

Properties

Name Type Required Restrictions Description
AccessKeyId string false none The ID of the access key.
CreateDate string false none The date of the creation of the access key.
Status string false none The state of the access key (Active if the key is valid for API calls, or Inactive if not).
UserName string false none The account name of the user the access key is associated with.

Schema

{
  "AccessKeyId": "string",
  "CreateDate": "string",
  "Status": "string",
  "UserName": "string"
}

AddUserToGroupResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

AttachGroupPolicyResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

AttachUserPolicyResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

AttachedPolicies

One or more policies attached to the specified user.

Properties

Name Type Required Restrictions Description
PolicyArn string false none The unique identifier of the policy (between 20 and 2048 characters).
PolicyName string false none The name of the attached policy (between 1 and 128 characters).

Schema

{
  "PolicyArn": "string",
  "PolicyName": "string"
}

CreateAccessKeyResponse

Properties

Name Type Required Restrictions Description
AccessKey AccessKey false none Information about the access key, in an XML file.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "AccessKey": {
    "AccessKeyId": "string",
    "CreateDate": "string",
    "SecretAccessKey": "string",
    "Status": "string",
    "UserName": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

CreateGroupResponse

Properties

Name Type Required Restrictions Description
Group Group false none Information about the newly created group, in an XML file.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "Group": {
    "Arn": "string",
    "CreateDate": "string",
    "GroupId": "string",
    "GroupName": "string",
    "Path": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

CreatePolicyResponse

Properties

Name Type Required Restrictions Description
Policy Policy false none Information about the newly created policy.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "Policy": {
    "Arn": "string",
    "AttachmentCount": 0,
    "CreateDate": "string",
    "DefaultVersionId": "string",
    "Description": "string",
    "IsAttachable": true,
    "Path": "string",
    "PolicyId": "string",
    "PolicyName": "string",
    "UpdateDate": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

CreatePolicyVersionResponse

Properties

Name Type Required Restrictions Description
PolicyVersion PolicyVersion false none Information about the policy version.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "PolicyVersion": {
    "CreateDate": "string",
    "Document": "string",
    "IsDefaultVersion": true,
    "VersionId": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

CreateUserResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.
User User false none Information about the newly created user.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "User": {
    "Arn": "string",
    "CreateDate": "string",
    "PasswordLastUsed": "string",
    "Path": "string",
    "UserId": "string",
    "UserName": "string"
  }
}

DeleteAccessKeyResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeleteGroupPolicyResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeleteGroupResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeletePolicyResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeletePolicyVersionResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeleteServerCertificateResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeleteUserPolicyResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DeleteUserResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DetachGroupPolicyResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

DetachUserPolicyResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

GetGroupPolicyResponse

Properties

Name Type Required Restrictions Description
GroupName string false none The name of the group in which the inline policy is included.
PolicyDocument string false none The policy document, providing a description of the policy.
PolicyName string false none The name of the inline policy.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "GroupName": "string",
  "PolicyDocument": "string",
  "PolicyName": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

GetGroupResponse

Properties

Name Type Required Restrictions Description
Group Group false none Information about the newly created group, in an XML file.
IsTruncated boolean false none If true, there are more items to return using the marker in a new request.
Marker string false none The marker to request the next results page.
ResponseMetadata ResponseMetadata false none Information about the response.
Users [Users] false none The list of users in the group.

Schema

{
  "Group": {
    "Arn": "string",
    "CreateDate": "string",
    "GroupId": "string",
    "GroupName": "string",
    "Path": "string"
  },
  "IsTruncated": true,
  "Marker": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "Users": [
    {
      "Arn": "string",
      "CreateDate": "string",
      "PasswordLastUsed": "string",
      "Path": "string",
      "UserId": "string",
      "UserName": "string"
    }
  ]
}

GetPolicyResponse

Properties

Name Type Required Restrictions Description
Policy Policy false none Information about the newly created policy.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "Policy": {
    "Arn": "string",
    "AttachmentCount": 0,
    "CreateDate": "string",
    "DefaultVersionId": "string",
    "Description": "string",
    "IsAttachable": true,
    "Path": "string",
    "PolicyId": "string",
    "PolicyName": "string",
    "UpdateDate": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

GetPolicyVersionResponse

Properties

Name Type Required Restrictions Description
PolicyVersion PolicyVersion false none Information about the policy version.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "PolicyVersion": {
    "CreateDate": "string",
    "Document": "string",
    "IsDefaultVersion": true,
    "VersionId": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

GetServerCertificateResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.
ServerCertificate ServerCertificate false none Information about the specified server certificate.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "ServerCertificate": {
    "CertificateBody": "string",
    "CertificateChain": "string",
    "ServerCertificateMetadata": {
      "Arn": "string",
      "Expiration": "string",
      "Path": "string",
      "ServerCertificateId": "string",
      "ServerCertificateName": "string",
      "UploadDate": "string"
    }
  }
}

GetUserPolicyResponse

Properties

Name Type Required Restrictions Description
PolicyDocument string false none The policy document, providing a description of the policy.
PolicyName string false none The name of the inline policy.
ResponseMetadata ResponseMetadata false none Information about the response.
UserName string false none The name of the user in which the inline policy is included.

Schema

{
  "PolicyDocument": "string",
  "PolicyName": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "UserName": "string"
}

GetUserResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.
User User false none Information about the newly created user.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "User": {
    "Arn": "string",
    "CreateDate": "string",
    "PasswordLastUsed": "string",
    "Path": "string",
    "UserId": "string",
    "UserName": "string"
  }
}

Group

Information about the newly created group, in an XML file.

Properties

Name Type Required Restrictions Description
Arn string false none The unique identifier of the group (between 20 and 2048 characters).
CreateDate string false none The date and time of creation of the group, in ISO 8601 format.
GroupId string false none The ID of the group.
GroupName string false none The name of the group.
Path string false none The path to the group.

Schema

{
  "Arn": "string",
  "CreateDate": "string",
  "GroupId": "string",
  "GroupName": "string",
  "Path": "string"
}

Groups

One or more groups the specified user belongs to.

Properties

Name Type Required Restrictions Description
Arn string false none The unique identifier of the group (between 20 and 2048 characters).
CreateDate string false none The date and time of creation of the group, in ISO 8601 format.
GroupId string false none The ID of the group.
GroupName string false none The name of the group.
Path string false none The path to the group.

Schema

{
  "Arn": "string",
  "CreateDate": "string",
  "GroupId": "string",
  "GroupName": "string",
  "Path": "string"
}

ListAccessKeysResponse

Properties

Name Type Required Restrictions Description
AccessKeyMetadata [AccessKeyMetadata] false none A list of access keys and their metadata.
IsTruncated boolean false none If true, there are more items to return using the marker in a new request.
Marker string false none The marker to request the next results page.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "AccessKeyMetadata": [
    {
      "AccessKeyId": "string",
      "CreateDate": "string",
      "Status": "string",
      "UserName": "string"
    }
  ],
  "IsTruncated": true,
  "Marker": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ListAttachedGroupPoliciesResponse

Properties

Name Type Required Restrictions Description
AttachedPolicies [AttachedPolicies] false none One or more policies attached to the specified group.
IsTruncated boolean false none If true, there are more items to return using the marker in a new request.
Marker string false none The marker to request the next results page.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "AttachedPolicies": [
    {
      "PolicyArn": "string",
      "PolicyName": "string"
    }
  ],
  "IsTruncated": true,
  "Marker": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ListAttachedUserPoliciesResponse

Properties

Name Type Required Restrictions Description
AttachedPolicies [AttachedPolicies] false none One or more policies attached to the specified user.
IsTruncated boolean false none If true, there are more items to return using the marker in a new request.
Marker string false none The marker to request the next results page.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "AttachedPolicies": [
    {
      "PolicyArn": "string",
      "PolicyName": "string"
    }
  ],
  "IsTruncated": true,
  "Marker": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ListGroupPoliciesResponse

Properties

Name Type Required Restrictions Description
IsTruncated boolean false none If true, there are more items to return using the marker in a new request.
Marker string false none The marker to request the next results page.
PolicyNames [string] false none One or more policy names.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "IsTruncated": true,
  "Marker": "string",
  "PolicyNames": [
    "string"
  ],
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ListGroupsForUserResponse

Properties

Name Type Required Restrictions Description
Groups [Groups] false none One or more groups the specified user belongs to.
IsTruncated boolean false none If true, there are more items to return using the marker in a new request.
Marker string false none The marker to request the next results page.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "Groups": [
    {
      "Arn": "string",
      "CreateDate": "string",
      "GroupId": "string",
      "GroupName": "string",
      "Path": "string"
    }
  ],
  "IsTruncated": true,
  "Marker": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ListGroupsResponse

Properties

Name Type Required Restrictions Description
Groups [Groups] false none One or more groups with the specified path prefix.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "Groups": [
    {
      "Arn": "string",
      "CreateDate": "string",
      "GroupId": "string",
      "GroupName": "string",
      "Path": "string"
    }
  ],
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ListPoliciesResponse

Properties

Name Type Required Restrictions Description
IsTruncated boolean false none If true, there are more items to return using the marker in a new request.
Marker string false none The marker to request the next results page.
Policies [Policies] false none Information about one or more policies.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "IsTruncated": true,
  "Marker": "string",
  "Policies": [
    {
      "Arn": "string",
      "AttachmentCount": 0,
      "CreateDate": "string",
      "DefaultVersionId": "string",
      "Description": "string",
      "IsAttachable": true,
      "Path": "string",
      "PolicyId": "string",
      "PolicyName": "string",
      "UpdateDate": "string"
    }
  ],
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ListPolicyVersionsResponse

Properties

Name Type Required Restrictions Description
IsTruncated boolean false none If true, there are more items to return using the marker in a new request.
Marker string false none The marker to request the next results page.
ResponseMetadata ResponseMetadata false none Information about the response.
Versions [Versions] false none A list of all the versions of the policy.

Schema

{
  "IsTruncated": true,
  "Marker": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "Versions": [
    {
      "CreateDate": "string",
      "Document": "string",
      "IsDefaultVersion": true,
      "VersionId": "string"
    }
  ]
}

ListServerCertificatesResponse

Properties

Name Type Required Restrictions Description
IsTruncated boolean false none If true, there are more items to return using the marker in a new request.
Marker string false none The marker to request the next results page.
ResponseMetadata ResponseMetadata false none Information about the response.
ServerCertificateMetadataList [ServerCertificateMetadataList] false none Information about one or more server certificates.

Schema

{
  "IsTruncated": true,
  "Marker": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "ServerCertificateMetadataList": [
    {
      "Arn": "string",
      "Expiration": "string",
      "Path": "string",
      "ServerCertificateId": "string",
      "ServerCertificateName": "string",
      "UploadDate": "string"
    }
  ]
}

ListUserPoliciesResponse

Properties

Name Type Required Restrictions Description
IsTruncated boolean false none If true, there are more items to return using the marker in a new request.
Marker string false none The marker to request the next results page.
PolicyNames [string] false none A list of policy names.
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "IsTruncated": true,
  "Marker": "string",
  "PolicyNames": [
    "string"
  ],
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ListUsersResponse

Properties

Name Type Required Restrictions Description
IsTruncated boolean false none If true, there are more items to return using the marker in a new request.
Marker string false none The marker to request the next results page.
ResponseMetadata ResponseMetadata false none Information about the response.
Users [Users] false none A list of users.

Schema

{
  "IsTruncated": true,
  "Marker": "string",
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "Users": [
    {
      "Arn": "string",
      "CreateDate": "string",
      "PasswordLastUsed": "string",
      "Path": "string",
      "UserId": "string",
      "UserName": "string"
    }
  ]
}

Policies

Information about one or more policies.

Properties

Name Type Required Restrictions Description
Arn string false none The unique identifier of the resource (between 20 and 2048 characters).
AttachmentCount integer false none The number of resources attached to the policy.
CreateDate string false none The date and time of creation of the policy, in ISO 8601 format.
DefaultVersionId string false none The ID of the policy default version.
Description string false none A friendly name for the policy (between 0 and 1000 characters).
IsAttachable boolean false none Indicates whether the policy can be attached to a group or an EIM user.
Path string false none The path to the policy.
PolicyId string false none The ID of the policy (between 16 and 32 characters).
PolicyName string false none The name of the policy (between 1 and 128 characters).
UpdateDate string false none The date and time when the policy was last updated, in ISO 8601 format.

Schema

{
  "Arn": "string",
  "AttachmentCount": 0,
  "CreateDate": "string",
  "DefaultVersionId": "string",
  "Description": "string",
  "IsAttachable": true,
  "Path": "string",
  "PolicyId": "string",
  "PolicyName": "string",
  "UpdateDate": "string"
}

Policy

Information about the newly created policy.

Properties

Name Type Required Restrictions Description
Arn string false none The unique identifier of the resource (between 20 and 2048 characters).
AttachmentCount integer false none The number of resources attached to the policy.
CreateDate string false none The date and time of creation of the policy, in ISO 8601 format.
DefaultVersionId string false none The ID of the policy default version.
Description string false none A friendly name for the policy (between 0 and 1000 characters).
IsAttachable boolean false none Indicates whether the policy can be attached to a group or an EIM user.
Path string false none The path to the policy.
PolicyId string false none The ID of the policy (between 16 and 32 characters).
PolicyName string false none The name of the policy (between 1 and 128 characters).
UpdateDate string false none The date and time when the policy was last updated, in ISO 8601 format.

Schema

{
  "Arn": "string",
  "AttachmentCount": 0,
  "CreateDate": "string",
  "DefaultVersionId": "string",
  "Description": "string",
  "IsAttachable": true,
  "Path": "string",
  "PolicyId": "string",
  "PolicyName": "string",
  "UpdateDate": "string"
}

PolicyVersion

Information about the policy version.

Properties

Name Type Required Restrictions Description
CreateDate string false none The date of the creation of the version.
Document string false none The policy document as a json string.
IsDefaultVersion boolean false none If true, the version is the default one.
VersionId string false none The ID of the version.

Schema

{
  "CreateDate": "string",
  "Document": "string",
  "IsDefaultVersion": true,
  "VersionId": "string"
}

PutGroupPolicyResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

PutUserPolicyResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

RemoveUserFromGroupResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ResponseMetadata

Information about the response.

Properties

Name Type Required Restrictions Description
RequestId string false none The ID of the request.

Schema

{
  "RequestId": "string"
}

ServerCertificate

Information about the specified server certificate.

Properties

Name Type Required Restrictions Description
CertificateBody string false none The PEM-encoded x509 certificate.
CertificateChain string false none The PEM-encoded intermediate certification authorities.
ServerCertificateMetadata ServerCertificateMetadata false none The metadata of the server certificate.

Schema

{
  "CertificateBody": "string",
  "CertificateChain": "string",
  "ServerCertificateMetadata": {
    "Arn": "string",
    "Expiration": "string",
    "Path": "string",
    "ServerCertificateId": "string",
    "ServerCertificateName": "string",
    "UploadDate": "string"
  }
}

ServerCertificateMetadata

The metadata of the server certificate.

Properties

Name Type Required Restrictions Description
Arn string false none The unique identifier of the server certificate (between 20 and 2048 characters), which can be used by EIM policies.
Expiration string false none The date at which the server certificate expires.
Path string false none The path to the server certificate.
ServerCertificateId string false none The ID of the server certificate, generated by EIM.
ServerCertificateName string false none The name of the server certificate.
UploadDate string false none The date at which the server certificate has been uploaded.

Schema

{
  "Arn": "string",
  "Expiration": "string",
  "Path": "string",
  "ServerCertificateId": "string",
  "ServerCertificateName": "string",
  "UploadDate": "string"
}

ServerCertificateMetadataList

Information about one or more server certificates.

Properties

Name Type Required Restrictions Description
Arn string false none The unique identifier of the server certificate (between 20 and 2048 characters), which can be used by EIM policies.
Expiration string false none The date at which the server certificate expires.
Path string false none The path to the server certificate.
ServerCertificateId string false none The ID of the server certificate, generated by EIM.
ServerCertificateName string false none The name of the server certificate.
UploadDate string false none The date at which the server certificate has been uploaded.

Schema

{
  "Arn": "string",
  "Expiration": "string",
  "Path": "string",
  "ServerCertificateId": "string",
  "ServerCertificateName": "string",
  "UploadDate": "string"
}

SetDefaultPolicyVersionResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

UpdateAccessKeyResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

UpdateGroupResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

UpdateServerCertificateResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

UpdateUserResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

UploadServerCertificateResponse

Properties

Name Type Required Restrictions Description
ResponseMetadata ResponseMetadata false none Information about the response.
ServerCertificateMetadata ServerCertificateMetadata false none The metadata of the server certificate.

Schema

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "ServerCertificateMetadata": {
    "Arn": "string",
    "Expiration": "string",
    "Path": "string",
    "ServerCertificateId": "string",
    "ServerCertificateName": "string",
    "UploadDate": "string"
  }
}

User

Information about the newly created user.

Properties

Name Type Required Restrictions Description
Arn string false none The unique identifier of the user (between 20 and 2048 characters).
CreateDate string false none The date and time of creation of the user, in ISO 8601 format.
PasswordLastUsed string false none The date and time when the user's password was last used, in ISO 8601 format.
Path string false none The path to the user.
UserId string false none The ID of the user.
UserName string false none The name of the user.

Schema

{
  "Arn": "string",
  "CreateDate": "string",
  "PasswordLastUsed": "string",
  "Path": "string",
  "UserId": "string",
  "UserName": "string"
}

Users

A list of users.

Properties

Name Type Required Restrictions Description
Arn string false none The unique identifier of the user (between 20 and 2048 characters).
CreateDate string false none The date and time of creation of the user, in ISO 8601 format.
PasswordLastUsed string false none The date and time when the user's password was last used, in ISO 8601 format.
Path string false none The path to the user.
UserId string false none The ID of the user.
UserName string false none The name of the user.

Schema

{
  "Arn": "string",
  "CreateDate": "string",
  "PasswordLastUsed": "string",
  "Path": "string",
  "UserId": "string",
  "UserName": "string"
}

Versions

A list of all the versions of the policy.

Properties

Name Type Required Restrictions Description
CreateDate string false none The date of the creation of the version.
Document string false none The policy document as a json string.
IsDefaultVersion boolean false none If true, the version is the default one.
VersionId string false none The ID of the version.

Schema

{
  "CreateDate": "string",
  "Document": "string",
  "IsDefaultVersion": true,
  "VersionId": "string"
}

Copyright ©2020 Outscale SAS. All rights reserved