EIM API 2010-05-08

The Elastic Identity Management (EIM) API enables you to manage identities and accesses for your resources in the 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:

• https://eim.{region}.outscale.com
  • region
    • ap-northeast-1
    • cloudgouv-eu-west-1
    • eu-west-2 (default)
    • us-east-2
    • us-west-1

Terms of service Email: Support License: BSD 3 Clause

Authentication

• API Key (ApiKeyAuth)
  • Parameter Name: Authorization, in: header. With this authentication scheme, you must use an access key to sign your API requests. For more information, see About Signatures of API Requests.
    In addition to your access key, you can configure API access rules with Certificate Authorities (CAs), requiring you to provide a certificate to perform actions. In that case, you can bypass systematically providing a certificate by activating a trusted session. For more information, see the UpdateApiAccessPolicy OUTSCALE API method and About Your API Access Policy.

Access Keys

CreateAccessKey

GET /CreateAccessKey

Creates an access key for the specified user. The new key is automatically set to Active.

Code samples

osc-cli eim CreateAccessKey --profile "default" \
  --UserName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=CreateAccessKey' \
  --data-urlencode 'UserName=string'

Parameters

Parameter	Type	Required	Description
UserName	string	false	The user name of the owner of the key to be created. If you do not specify a user name, this action creates an access key for the user who sends the request.

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 specified access key of the specified user.

[NOTE]

Code samples

osc-cli eim DeleteAccessKey --profile "default" \
  --AccessKeyId "string" \
  --UserName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=DeleteAccessKey' \
  --data-urlencode 'AccessKeyId=string' \
  --data-urlencode 'UserName=string'

Parameters

Parameter	Type	Required	Description
AccessKeyId	string	true	The ID of the access key you want to delete.
UserName	string	false	The user name the access key you want to delete is associated with. By default, the user who sends the request.

Responses

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

Example responses

200 Response

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

ListAccessKeys

GET /ListAccessKeys

Lists information about the access key IDs of the specified user.

Code samples

osc-cli eim ListAccessKeys --profile "default" \
  --Marker "string" \
  --MaxItems 0 \
  --UserName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=ListAccessKeys' \
  --data-urlencode 'Marker=string' \
  --data-urlencode 'MaxItems=0' \
  --data-urlencode 'UserName=string'

Parameters

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

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.

Code samples

osc-cli eim UpdateAccessKey --profile "default" \
  --AccessKeyId "string" \
  --Status "string" \
  --UserName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=UpdateAccessKey' \
  --data-urlencode 'AccessKeyId=string' \
  --data-urlencode 'Status=string' \
  --data-urlencode 'UserName=string'

Parameters

Parameter	Type	Required	Description
AccessKeyId	string	true	The ID of the access key.
Status	string	true	The status of the access key (Active | Inactive).
UserName	string	false	The user name the access key you want to modify is associated with. If you do not specify a user name, this action modifies the access key of the user who sends the request.

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.

Code samples

osc-cli eim DeleteServerCertificate --profile "default" \
  --ServerCertificateName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=DeleteServerCertificate' \
  --data-urlencode 'ServerCertificateName=string'

Parameters

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

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.

Code samples

osc-cli eim GetServerCertificate --profile "default" \
  --ServerCertificateName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=GetServerCertificate' \
  --data-urlencode 'ServerCertificateName=string'

Parameters

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

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.

Code samples

osc-cli eim ListServerCertificates --profile "default" \
  --Marker "string" \
  --MaxItems 0 \
  --PathPrefix "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=ListServerCertificates' \
  --data-urlencode 'Marker=string' \
  --data-urlencode 'MaxItems=0' \
  --data-urlencode 'PathPrefix=string'

Parameters

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

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.

Code samples

osc-cli eim UpdateServerCertificate --profile "default" \
  --NewPath "string" \
  --NewServerCertificateName "string" \
  --ServerCertificateName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=UpdateServerCertificate' \
  --data-urlencode 'NewPath=string' \
  --data-urlencode 'NewServerCertificateName=string' \
  --data-urlencode 'ServerCertificateName=string'

Parameters

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

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.

Code samples

osc-cli eim UploadServerCertificate --profile "default" \
  --CertificateBody="$(cat certificate.pem)" \
  --CertificateChain="$(cat certificate-chain.pem)" \
  --Path "string" \
  --PrivateKey="$(cat private-key.pem)" \
  --ServerCertificateName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=UploadServerCertificate' \
  --data-urlencode 'CertificateBody=string' \
  --data-urlencode 'CertificateChain=string' \
  --data-urlencode 'Path=string' \
  --data-urlencode 'PrivateKey=string' \
  --data-urlencode 'ServerCertificateName=string'

Parameters

Parameter	Type	Required	Description
CertificateBody	string	true	The PEM-encoded X509 certificate. With OSC CLI, use the following syntax to make sure your CA file is correctly parsed: --CaPem="$(cat FILENAME)".
CertificateChain	string	false	The PEM-encoded intermediate certification authorities. With OSC CLI, use the following syntax to make sure your CA file is correctly parsed: --CaPem="$(cat FILENAME)".
Path	string	false	The path to the server certificate, set to a slash (/) if not specified.
PrivateKey	string	true	The PEM-encoded private key matching the certificate. With OSC CLI, use the following syntax to make sure your CA file is correctly parsed: --CaPem="$(cat FILENAME)".
ServerCertificateName	string	true	A unique name for the certificate. Constraints: 1-128 alphanumeric characters, pluses (+), equals (=), commas (,), periods (.), at signs (@), minuses (-), or underscores (_).

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.

Code samples

osc-cli eim AddUserToGroup --profile "default" \
  --GroupName "string" \
  --UserName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=AddUserToGroup' \
  --data-urlencode 'GroupName=string' \
  --data-urlencode 'UserName=string'

Parameters

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

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.

Code samples

osc-cli eim CreateGroup --profile "default" \
  --GroupName "string" \
  --Path "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=CreateGroup' \
  --data-urlencode 'GroupName=string' \
  --data-urlencode 'Path=string'

Parameters

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

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.

Code samples

osc-cli eim DeleteGroup --profile "default" \
  --GroupName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=DeleteGroup' \
  --data-urlencode 'GroupName=string'

Parameters

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

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.

Code samples

osc-cli eim GetGroup --profile "default" \
  --GroupName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=GetGroup' \
  --data-urlencode 'GroupName=string'

Parameters

Parameter	Type	Required	Description
GroupName	string	true	The name of the group.

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"
  },
  "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).

Code samples

osc-cli eim ListGroups --profile "default" \
  --PathPrefix "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=ListGroups' \
  --data-urlencode 'PathPrefix=string'

Parameters

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

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.

Code samples

osc-cli eim ListGroupsForUser --profile "default" \
  --UserName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=ListGroupsForUser' \
  --data-urlencode 'UserName=string'

Parameters

Parameter	Type	Required	Description
UserName	string	true	The name of the user.

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"
    }
  ],
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

RemoveUserFromGroup

GET /RemoveUserFromGroup

Removes a specified user from a specified group.

Code samples

osc-cli eim RemoveUserFromGroup --profile "default" \
  --GroupName "string" \
  --UserName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=RemoveUserFromGroup' \
  --data-urlencode 'GroupName=string' \
  --data-urlencode 'UserName=string'

Parameters

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

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.

Code samples

osc-cli eim UpdateGroup --profile "default" \
  --GroupName "string" \
  --NewGroupName "string" \
  --NewPath "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=UpdateGroup' \
  --data-urlencode 'GroupName=string' \
  --data-urlencode 'NewGroupName=string' \
  --data-urlencode 'NewPath=string'

Parameters

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

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.

Code samples

osc-cli eim AttachGroupPolicy --profile "default" \
  --GroupName "string" \
  --PolicyArn "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=AttachGroupPolicy' \
  --data-urlencode 'GroupName=string' \
  --data-urlencode 'PolicyArn=string'

Parameters

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

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.

Code samples

osc-cli eim AttachUserPolicy --profile "default" \
  --PolicyArn "string" \
  --UserName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=AttachUserPolicy' \
  --data-urlencode 'PolicyArn=string' \
  --data-urlencode 'UserName=string'

Parameters

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

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 managed policy to apply to a user or a group.
This action creates a policy version and sets v1 as the default one.

Code samples

osc-cli eim CreatePolicy --profile "default" \
  --Description "string" \
  --Path "string" \
  --PolicyDocument "string" \
  --PolicyName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=CreatePolicy' \
  --data-urlencode 'Description=string' \
  --data-urlencode 'Path=string' \
  --data-urlencode 'PolicyDocument=string' \
  --data-urlencode 'PolicyName=string'

Parameters

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

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 version of a specified managed policy.
A managed policy can have up to five versions.

Code samples

osc-cli eim CreatePolicyVersion --profile "default" \
  --PolicyArn "string" \
  --PolicyDocument "string" \
  --SetAsDefault True

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=CreatePolicyVersion' \
  --data-urlencode 'PolicyArn=string' \
  --data-urlencode 'PolicyDocument=string' \
  --data-urlencode 'SetAsDefault=true'

Parameters

Parameter	Type	Required	Description
PolicyArn	string	true	The OUTSCALE Resource Name (ORN) of the policy. For more information, see Resource Identifiers.
PolicyDocument	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	boolean	false	If set to true, the new policy version is the default version and becomes the operative one.

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.

Code samples

osc-cli eim DeleteGroupPolicy --profile "default" \
  --GroupName "string" \
  --PolicyName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=DeleteGroupPolicy' \
  --data-urlencode 'GroupName=string' \
  --data-urlencode 'PolicyName=string'

Parameters

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

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.

Code samples

osc-cli eim DeletePolicy --profile "default" \
  --PolicyArn "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=DeletePolicy' \
  --data-urlencode 'PolicyArn=string'

Parameters

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

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.

Code samples

osc-cli eim DeletePolicyVersion --profile "default" \
  --PolicyArn "string" \
  --VersionId "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=DeletePolicyVersion' \
  --data-urlencode 'PolicyArn=string' \
  --data-urlencode 'VersionId=string'

Parameters

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

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.

Code samples

osc-cli eim DeleteUserPolicy --profile "default" \
  --PolicyName "string" \
  --UserName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=DeleteUserPolicy' \
  --data-urlencode 'PolicyName=string' \
  --data-urlencode 'UserName=string'

Parameters

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

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.

Code samples

osc-cli eim DetachGroupPolicy --profile "default" \
  --GroupName "string" \
  --PolicyArn "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=DetachGroupPolicy' \
  --data-urlencode 'GroupName=string' \
  --data-urlencode 'PolicyArn=string'

Parameters

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

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.

Code samples

osc-cli eim DetachUserPolicy --profile "default" \
  --PolicyArn "string" \
  --UserName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=DetachUserPolicy' \
  --data-urlencode 'PolicyArn=string' \
  --data-urlencode 'UserName=string'

Parameters

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

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.

Code samples

osc-cli eim GetGroupPolicy --profile "default" \
  --GroupName "string" \
  --PolicyName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=GetGroupPolicy' \
  --data-urlencode 'GroupName=string' \
  --data-urlencode 'PolicyName=string'

Parameters

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

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.

Code samples

osc-cli eim GetPolicy --profile "default" \
  --PolicyArn "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=GetPolicy' \
  --data-urlencode 'PolicyArn=string'

Parameters

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

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.

Code samples

osc-cli eim GetPolicyVersion --profile "default" \
  --PolicyArn "string" \
  --VersionId "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=GetPolicyVersion' \
  --data-urlencode 'PolicyArn=string' \
  --data-urlencode 'VersionId=string'

Parameters

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

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.

Code samples

osc-cli eim GetUserPolicy --profile "default" \
  --PolicyName "string" \
  --UserName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=GetUserPolicy' \
  --data-urlencode 'PolicyName=string' \
  --data-urlencode 'UserName=string'

Parameters

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

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.

Code samples

osc-cli eim ListAttachedGroupPolicies --profile "default" \
  --GroupName "string" \
  --Marker "string" \
  --MaxItems 0 \
  --PathPrefix "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=ListAttachedGroupPolicies' \
  --data-urlencode 'GroupName=string' \
  --data-urlencode 'Marker=string' \
  --data-urlencode 'MaxItems=0' \
  --data-urlencode 'PathPrefix=string'

Parameters

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

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.

Code samples

osc-cli eim ListAttachedUserPolicies --profile "default" \
  --Marker "string" \
  --MaxItems 0 \
  --PathPrefix "string" \
  --UserName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=ListAttachedUserPolicies' \
  --data-urlencode 'Marker=string' \
  --data-urlencode 'MaxItems=0' \
  --data-urlencode 'PathPrefix=string' \
  --data-urlencode 'UserName=string'

Parameters

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

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.

Code samples

osc-cli eim ListGroupPolicies --profile "default" \
  --GroupName "string" \
  --Marker "string" \
  --MaxItems 0

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=ListGroupPolicies' \
  --data-urlencode 'GroupName=string' \
  --data-urlencode 'Marker=string' \
  --data-urlencode 'MaxItems=0'

Parameters

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

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.

Code samples

osc-cli eim ListPolicies --profile "default" \
  --Marker "string" \
  --MaxItems 0 \
  --OnlyAttached True \
  --PathPrefix "string" \
  --Scope "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=ListPolicies' \
  --data-urlencode 'Marker=string' \
  --data-urlencode 'MaxItems=0' \
  --data-urlencode 'OnlyAttached=true' \
  --data-urlencode 'PathPrefix=string' \
  --data-urlencode 'Scope=string'

Parameters

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

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.

Code samples

osc-cli eim ListPolicyVersions --profile "default" \
  --Marker "string" \
  --MaxItems 0 \
  --PolicyArn "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=ListPolicyVersions' \
  --data-urlencode 'Marker=string' \
  --data-urlencode 'MaxItems=0' \
  --data-urlencode 'PolicyArn=string'

Parameters

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

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.

Code samples

osc-cli eim ListUserPolicies --profile "default" \
  --UserName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=ListUserPolicies' \
  --data-urlencode 'UserName=string'

Parameters

Parameter	Type	Required	Description
UserName	string	true	The name of the user.

Responses

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

Example responses

200 Response

{
  "ListUserPoliciesResult": {
    "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.

Code samples

osc-cli eim PutGroupPolicy --profile "default" \
  --GroupName "string" \
  --PolicyDocument "string" \
  --PolicyName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=PutGroupPolicy' \
  --data-urlencode 'GroupName=string' \
  --data-urlencode 'PolicyDocument=string' \
  --data-urlencode 'PolicyName=string'

Parameters

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

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.

Code samples

osc-cli eim PutUserPolicy --profile "default" \
  --PolicyDocument "string" \
  --PolicyName "string" \
  --UserName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=PutUserPolicy' \
  --data-urlencode 'PolicyDocument=string' \
  --data-urlencode 'PolicyName=string' \
  --data-urlencode 'UserName=string'

Parameters

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

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.

Code samples

osc-cli eim SetDefaultPolicyVersion --profile "default" \
  --PolicyArn "string" \
  --VersionId "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=SetDefaultPolicyVersion' \
  --data-urlencode 'PolicyArn=string' \
  --data-urlencode 'VersionId=string'

Parameters

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

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 user for your account.

Code samples

osc-cli eim CreateUser --profile "default" \
  --Path "string" \
  --UserName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=CreateUser' \
  --data-urlencode 'Path=string' \
  --data-urlencode 'UserName=string'

Parameters

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

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.

Code samples

osc-cli eim DeleteUser --profile "default" \
  --UserName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=DeleteUser' \
  --data-urlencode 'UserName=string'

Parameters

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

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.

Code samples

osc-cli eim GetUser --profile "default" \
  --UserName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=GetUser' \
  --data-urlencode 'UserName=string'

Parameters

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

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).

Code samples

osc-cli eim ListUsers --profile "default" \
  --PathPrefix "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=ListUsers' \
  --data-urlencode 'PathPrefix=string'

Parameters

Parameter	Type	Required	Description
PathPrefix	string	false	The path prefix.

Responses

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

Example responses

200 Response

{
  "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.

Code samples

osc-cli eim UpdateUser --profile "default" \
  --NewPath "string" \
  --NewUserName "string" \
  --UserName "string"

# To use this command, you need to install version 7.75 (or later) of curl and libcurl from https://github.com/curl/curl

curl https://eim.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2010-05-08' \
  --data-urlencode 'Action=UpdateUser' \
  --data-urlencode 'NewPath=string' \
  --data-urlencode 'NewUserName=string' \
  --data-urlencode 'UserName=string'

Parameters

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

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.

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

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.
ResponseMetadata	ResponseMetadata	false	none	Information about the response.

Schema

{
  "Groups": [
    {
      "Arn": "string",
      "CreateDate": "string",
      "GroupId": "string",
      "GroupName": "string",
      "Path": "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
ListUserPoliciesResult	ListUserPoliciesResult	false	none	Information about one or more user policies.
ResponseMetadata	ResponseMetadata	false	none	Information about the response.

Schema

{
  "ListUserPoliciesResult": {
    "PolicyNames": "string"
  },
  "ResponseMetadata": {
    "RequestId": "string"
  }
}

ListUserPoliciesResult

Information about one or more user policies.

Properties

Name	Type	Required	Restrictions	Description
PolicyNames	string	false	none	A list of policy names.

Schema

{
  "PolicyNames": "string"
}

ListUsersResponse

Properties

Name	Type	Required	Restrictions	Description
ResponseMetadata	ResponseMetadata	false	none	Information about the response.
Users	[Users]	false	none	A list of users.

Schema

{
  "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 © 2023 Outscale SAS. All rights reserved.