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
Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.
Endpoints
Name | Base URL |
---|---|
ap-northeast-1 | https://eim.ap-northeast-1.outscale.com |
cloudgouv-eu-west-1 | https://eim.cloudgouv-eu-west-1.outscale.com |
eu-west-2 (default) | https://eim.eu-west-2.outscale.com |
us-east-2 | https://eim.us-east-2.outscale.com |
us-west-1 | https://eim.us-west-1.outscale.com |
Terms of service. Email: support@outscale.com. License: BSD 3 Clause.
Authentication Schemes
Access Key/Secret Key
The main way to authenticate your requests to this API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in Signature of API Requests.
In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
For example, if you use OSC CLI:
- You need to create an ~/.osc/config.json file to specify your access key, secret key, and the Region of your account.
- You then specify the
--profile
option when executing OSC CLI commands.For more information, see Installing and Configuring OSC CLI.
See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see About Access Keys.
Other Security Mechanisms
In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.
For more information, see Managing Your API Accesses.
Access Keys
CreateAccessKey
POST /CreateAccessKey
Creates an access key for the specified user. The new key is automatically set to Active
.
For more information, see About Access Keys.
This AWS-compliant method corresponds to CreateAccessKey in the OUTSCALE API.
Request Parameters
osc-cli eim CreateAccessKey --profile "default" \
--UserName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (CreateAccessKeyRequest):
Body Parameter | Type | Description |
---|---|---|
UserName | string | 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. |
Response Elements
200 Response
{
"AccessKey": {
"AccessKeyId": "string",
"CreateDate": "string",
"SecretAccessKey": "string",
"Status": "string",
"UserName": "string"
},
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (CreateAccessKeyResponse):
Response Element | Type | Description |
---|---|---|
AccessKey | AccessKey | Information about the access key. |
AccessKeyId | string | The ID of the access key. |
CreateDate | string | The date of the creation of the access key. |
SecretAccessKey | string | The secret key that enables you to send requests. |
Status | string | The state of the access key (Active if the key is valid for API calls, or Inactive if not). |
UserName | string | The name of the user the access key is associated with. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
DeleteAccessKey
POST /DeleteAccessKey
Deletes the specified access key of the specified user.
This AWS-compliant method corresponds to DeleteAcessKey in the OUTSCALE API.
Request Parameters
osc-cli eim DeleteAccessKey --profile "default" \
--AccessKeyId "string" \
--UserName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (DeleteAccessKeyRequest):
Body Parameter | Type | Description |
---|---|---|
AccessKeyId (required) | string | The ID of the access key you want to delete. |
UserName | string | The user name the access key you want to delete is associated with. By default, the user who sends the request. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (DeleteAccessKeyResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
ListAccessKeys
POST /ListAccessKeys
Lists information about the access key IDs of the specified user.
This AWS-compliant method corresponds to ReadAccessKeys in the OUTSCALE API.
Request Parameters
osc-cli eim ListAccessKeys --profile "default" \
--Marker "string" \
--MaxItems 0 \
--UserName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (ListAccessKeysRequest):
Body Parameter | Type | Description |
---|---|---|
Marker | string | The marker to request the next results page. |
MaxItems | integer | The maximum number of items that can be returned in a single page (by default, 100 ). |
UserName | string | The name of the user. By default, the user who sends the request. |
Response Elements
200 Response
{
"AccessKeyMetadata": [
{
"AccessKeyId": "string",
"CreateDate": "string",
"Status": "string",
"UserName": "string"
}
],
"IsTruncated": true,
"Marker": "string",
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (ListAccessKeysResponse):
Response Element | Type | Description |
---|---|---|
AccessKeyMetadata | [AccessKeyMetadata] | A list of access keys and their metadata. |
AccessKeyId | string | The ID of the access key. |
CreateDate | string | The date of the creation of the access key. |
Status | string | The state of the access key (Active if the key is valid for API calls, or Inactive if not). |
UserName | string | The name of the user the access key is associated with. |
IsTruncated | boolean | If true, there are more items to return using the marker in a new request. |
Marker | string | The marker to request the next results page. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
UpdateAccessKey
POST /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.
This AWS-compliant method corresponds to UpdateAccessKey in the OUTSCALE API.
Request Parameters
osc-cli eim UpdateAccessKey --profile "default" \
--AccessKeyId "string" \
--Status "string" \
--UserName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (UpdateAccessKeyRequest):
Body Parameter | Type | Description |
---|---|---|
AccessKeyId (required) | string | The ID of the access key. |
Status (required) | string | The status of the access key (Active | Inactive ). |
UserName | string | 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. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (UpdateAccessKeyResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
Certificates
DeleteServerCertificate
POST /DeleteServerCertificate
Deletes a specified server certificate.
This AWS-compliant method corresponds to DeleteServerCertificate in the OUTSCALE API.
Request Parameters
osc-cli eim DeleteServerCertificate --profile "default" \
--ServerCertificateName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (DeleteServerCertificateRequest):
Body Parameter | Type | Description |
---|---|---|
ServerCertificateName (required) | string | The name of the server certificate you want to delete. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (DeleteServerCertificateResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
GetServerCertificate
POST /GetServerCertificate
Retrieves information about a specified server certificate.
Request Parameters
osc-cli eim GetServerCertificate --profile "default" \
--ServerCertificateName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (GetServerCertificateRequest):
Body Parameter | Type | Description |
---|---|---|
ServerCertificateName (required) | string | The name of the server certificate you want information about. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
},
"ServerCertificate": {
"CertificateBody": "string",
"CertificateChain": "string",
"ServerCertificateMetadata": {
"Arn": "string",
"Expiration": "string",
"Path": "string",
"ServerCertificateId": "string",
"ServerCertificateName": "string",
"UploadDate": "string"
}
}
}
Response 200 (GetServerCertificateResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
ServerCertificate | ServerCertificate | Information about the specified server certificate. |
CertificateBody | string | The PEM-encoded x509 certificate. |
CertificateChain | string | The PEM-encoded intermediate certification authorities. |
ServerCertificateMetadata | ServerCertificateMetadata | The metadata of the server certificate. |
Arn | string | The unique identifier of the server certificate (between 20 and 2048 characters), which can be used by EIM policies. |
Expiration | string | The date at which the server certificate expires. |
Path | string | The path to the server certificate. |
ServerCertificateId | string | The ID of the server certificate, generated by EIM. |
ServerCertificateName | string | The name of the server certificate. |
UploadDate | string | The date at which the server certificate has been uploaded. |
ListServerCertificates
POST /ListServerCertificates
Lists your server certificates.
This AWS-compliant method corresponds to ReadServerCertificates in the OUTSCALE API.
Request Parameters
osc-cli eim ListServerCertificates --profile "default" \
--Marker "string" \
--MaxItems 0 \
--PathPrefix "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (ListServerCertificatesRequest):
Body Parameter | Type | Description |
---|---|---|
Marker | string | The marker to request the next results page. |
MaxItems | integer | The maximum number of items that can be returned in a single page (by default, 1000 ). |
PathPrefix | string | The path prefix of the server certificates, set to a slash (/ ) if not specified. |
Response Elements
200 Response
{
"IsTruncated": true,
"Marker": "string",
"ResponseMetadata": {
"RequestId": "string"
},
"ServerCertificateMetadataList": [
{
"Arn": "string",
"Expiration": "string",
"Path": "string",
"ServerCertificateId": "string",
"ServerCertificateName": "string",
"UploadDate": "string"
}
]
}
Response 200 (ListServerCertificatesResponse):
Response Element | Type | Description |
---|---|---|
IsTruncated | boolean | If true, there are more items to return using the marker in a new request. |
Marker | string | The marker to request the next results page. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
ServerCertificateMetadataList | [ServerCertificateMetadataList] | Information about one or more server certificates. |
Arn | string | The unique identifier of the server certificate (between 20 and 2048 characters), which can be used by EIM policies. |
Expiration | string | The date at which the server certificate expires. |
Path | string | The path to the server certificate. |
ServerCertificateId | string | The ID of the server certificate, generated by EIM. |
ServerCertificateName | string | The name of the server certificate. |
UploadDate | string | The date at which the server certificate has been uploaded. |
UpdateServerCertificate
POST /UpdateServerCertificate
Modifies the name and/or the path of a specified server certificate.
This AWS-compliant method corresponds to UpdateServerCertificate in the OUTSCALE API.
Request Parameters
osc-cli eim UpdateServerCertificate --profile "default" \
--NewPath "string" \
--NewServerCertificateName "string" \
--ServerCertificateName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (UpdateServerCertificateRequest):
Body Parameter | Type | Description |
---|---|---|
NewPath | string | A new path for the server certificate. |
NewServerCertificateName | string | A new name for the server certificate. |
ServerCertificateName (required) | string | The name of the server certificate you want to modify. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (UpdateServerCertificateResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
UploadServerCertificate
POST /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 be 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.
For more information, see About Server Certificates in EIM.
This AWS-compliant method corresponds to CreateServerCertificate in the OUTSCALE API.
Request Parameters
osc-cli eim UploadServerCertificate --profile "default" \
--CertificateBody="$(cat certificate.pem)" \
--CertificateChain="$(cat certificate-chain.pem)" \
--Path "string" \
--PrivateKey="$(cat private-key.pem)" \
--ServerCertificateName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (UploadServerCertificateRequest):
Body Parameter | Type | Description |
---|---|---|
CertificateBody (required) | string | The PEM-encoded X509 certificate. With OSC CLI, use the following syntax to make sure your certificate file is correctly parsed: --CertificateBody="$(cat FILENAME)" . |
CertificateChain | string | The PEM-encoded intermediate certification authorities. With OSC CLI, use the following syntax to make sure your certificate chain file is correctly parsed: --CertificateChain="$(cat FILENAME)" . |
Path | string | The path to the server certificate, set to a slash (/ ) if not specified. |
PrivateKey (required) | string | The PEM-encoded private key matching the certificate. With OSC CLI, use the following syntax to make sure your key file is correctly parsed: --PrivateKey="$(cat FILENAME)" . |
ServerCertificateName (required) | string | A unique name for the certificate. Constraints: 1-128 alphanumeric characters, pluses ( + ), equals (= ), commas (, ), periods (. ), at signs (@ ), minuses (- ), or underscores (_ ). |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
},
"ServerCertificateMetadata": {
"Arn": "string",
"Expiration": "string",
"Path": "string",
"ServerCertificateId": "string",
"ServerCertificateName": "string",
"UploadDate": "string"
}
}
Response 200 (UploadServerCertificateResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
ServerCertificateMetadata | ServerCertificateMetadata | The metadata of the server certificate. |
Arn | string | The unique identifier of the server certificate (between 20 and 2048 characters), which can be used by EIM policies. |
Expiration | string | The date at which the server certificate expires. |
Path | string | The path to the server certificate. |
ServerCertificateId | string | The ID of the server certificate, generated by EIM. |
ServerCertificateName | string | The name of the server certificate. |
UploadDate | string | The date at which the server certificate has been uploaded. |
Groups
AddUserToGroup
POST /AddUserToGroup
Adds a user to a specified group.
This AWS-compliant method corresponds to AddUserToUserGroup in the OUTSCALE API.
Request Parameters
osc-cli eim AddUserToGroup --profile "default" \
--GroupName "string" \
--UserName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (AddUserToGroupRequest):
Body Parameter | Type | Description |
---|---|---|
GroupName (required) | string | The name of the group you want to add a user to. |
UserName (required) | string | The name of the user you want to add to the group. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (AddUserToGroupResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
CreateGroup
POST /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.
For more information, see About EIM Groups.
This AWS-compliant method corresponds to CreateUserGroup in the OUTSCALE API.
Request Parameters
osc-cli eim CreateGroup --profile "default" \
--GroupName "string" \
--Path "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (CreateGroupRequest):
Body Parameter | Type | Description |
---|---|---|
GroupName (required) | string | The name of the group to be created. |
Path | string | The path to the group, set to a slash (/ ) if not specified. |
Response Elements
200 Response
{
"Group": {
"Arn": "string",
"CreateDate": "string",
"GroupId": "string",
"GroupName": "string",
"Path": "string"
},
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (CreateGroupResponse):
Response Element | Type | Description |
---|---|---|
Group | Group | Information about the newly created group. |
Arn | string | The unique identifier of the group (between 20 and 2048 characters). |
CreateDate | string | The date and time of creation of the group, in ISO 8601 format. |
GroupId | string | The ID of the group. |
GroupName | string | The name of the group. |
Path | string | The path to the group. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
DeleteGroup
POST /DeleteGroup
Deletes a specified group.
The group must be empty of any user and must not have any attached policy.
This AWS-compliant method corresponds to DeleteUserGroup in the OUTSCALE API.
Request Parameters
osc-cli eim DeleteGroup --profile "default" \
--GroupName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (DeleteGroupRequest):
Body Parameter | Type | Description |
---|---|---|
GroupName (required) | string | The name of the group you want to delete. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (DeleteGroupResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
GetGroup
POST /GetGroup
Retrieves the list of users that are in a specified group or lists the groups a user belongs to.
This AWS-compliant method corresponds to ReadUserGroup in the OUTSCALE API.
Request Parameters
osc-cli eim GetGroup --profile "default" \
--GroupName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (GetGroupRequest):
Body Parameter | Type | Description |
---|---|---|
GroupName (required) | string | The name of the group. |
Response Elements
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"
}
]
}
Response 200 (GetGroupResponse):
Response Element | Type | Description |
---|---|---|
Group | Group | Information about the newly created group. |
Arn | string | The unique identifier of the group (between 20 and 2048 characters). |
CreateDate | string | The date and time of creation of the group, in ISO 8601 format. |
GroupId | string | The ID of the group. |
GroupName | string | The name of the group. |
Path | string | The path to the group. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
Users | [Users] | The list of users in the group. |
Arn | string | The unique identifier of the user (between 20 and 2048 characters). |
CreateDate | string | The date and time of creation of the user, in ISO 8601 format. |
PasswordLastUsed | string | The date and time when the user's password was last used, in ISO 8601 format. |
Path | string | The path to the user. |
UserId | string | The ID of the user. |
UserName | string | The name of the user. |
ListGroups
POST /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).
This AWS-compliant method corresponds to ReadUserGroups in the OUTSCALE API.
Request Parameters
osc-cli eim ListGroups --profile "default" \
--PathPrefix "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (ListGroupsRequest):
Body Parameter | Type | Description |
---|---|---|
PathPrefix | string | The path prefix with which you want to filter the results. If not specified, it is set to a slash (/ ). |
Response Elements
200 Response
{
"Groups": [
{
"Arn": "string",
"CreateDate": "string",
"GroupId": "string",
"GroupName": "string",
"Path": "string"
}
],
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (ListGroupsResponse):
Response Element | Type | Description |
---|---|---|
Groups | [Groups] | One or more groups with the specified path prefix. |
Arn | string | The unique identifier of the group (between 20 and 2048 characters). |
CreateDate | string | The date and time of creation of the group, in ISO 8601 format. |
GroupId | string | The ID of the group. |
GroupName | string | The name of the group. |
Path | string | The path to the group. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
ListGroupsForUser
POST /ListGroupsForUser
Lists the groups a specified user belongs to.
This AWS-compliant method corresponds to ReadUserGroupsPerUser in the OUTSCALE API.
Request Parameters
osc-cli eim ListGroupsForUser --profile "default" \
--UserName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (ListGroupsForUserRequest):
Body Parameter | Type | Description |
---|---|---|
UserName (required) | string | The name of the user. |
Response Elements
200 Response
{
"Groups": [
{
"Arn": "string",
"CreateDate": "string",
"GroupId": "string",
"GroupName": "string",
"Path": "string"
}
],
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (ListGroupsForUserResponse):
Response Element | Type | Description |
---|---|---|
Groups | [Groups] | One or more groups the specified user belongs to. |
Arn | string | The unique identifier of the group (between 20 and 2048 characters). |
CreateDate | string | The date and time of creation of the group, in ISO 8601 format. |
GroupId | string | The ID of the group. |
GroupName | string | The name of the group. |
Path | string | The path to the group. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
RemoveUserFromGroup
POST /RemoveUserFromGroup
Removes a specified user from a specified group.
This AWS-compliant method corresponds to RemoveUserFromUserGroup in the OUTSCALE API.
Request Parameters
osc-cli eim RemoveUserFromGroup --profile "default" \
--GroupName "string" \
--UserName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (RemoveUserFromGroupRequest):
Body Parameter | Type | Description |
---|---|---|
GroupName (required) | string | The name of the group you want to remove the user from. |
UserName (required) | string | The name of the user you want to remove from the group. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (RemoveUserFromGroupResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
UpdateGroup
POST /UpdateGroup
Modifies the name and/or the path of a specified group.
This AWS-compliant method corresponds to UpdateUserGroup in the OUTSCALE API.
Request Parameters
osc-cli eim UpdateGroup --profile "default" \
--GroupName "string" \
--NewGroupName "string" \
--NewPath "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (UpdateGroupRequest):
Body Parameter | Type | Description |
---|---|---|
GroupName (required) | string | The name of the group you want to modify. |
NewGroupName | string | A new name for the group. |
NewPath | string | A new path for the group. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (UpdateGroupResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
Policies
AttachGroupPolicy
POST /AttachGroupPolicy
Attaches a managed policy to a specific group. This policy applies to all the users contained in this group.
This AWS-compliant method corresponds to LinkManagedPolicyToUserGroup in the OUTSCALE API.
Request Parameters
osc-cli eim AttachGroupPolicy --profile "default" \
--GroupName "string" \
--PolicyArn "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (AttachGroupPolicyRequest):
Body Parameter | Type | Description |
---|---|---|
GroupName (required) | string | The friendly name given to the group you want to attach the policy to (between 1 and 128 characters). |
PolicyArn (required) | string | The unique resource identifier for the policy (between 20 and 2048 characters). |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (AttachGroupPolicyResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
AttachUserPolicy
POST /AttachUserPolicy
Attaches a managed policy to a specific user.
This AWS-compliant method corresponds to LinkPolicy in the OUTSCALE API.
Request Parameters
osc-cli eim AttachUserPolicy --profile "default" \
--PolicyArn "string" \
--UserName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (AttachUserPolicyRequest):
Body Parameter | Type | Description |
---|---|---|
PolicyArn (required) | string | The unique resource identifier for the policy (between 20 and 2048 characters). |
UserName (required) | string | The friendly name of the user you want to attach the policy to (between 1 and 64 characters). |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (AttachUserPolicyResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
CreatePolicy
POST /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.
For more information, see About Policies.
This AWS-compliant method corresponds to CreatePolicy in the OUTSCALE API.
Request Parameters
osc-cli eim CreatePolicy --profile "default" \
--Description "string" \
--Path "string" \
--PolicyDocument "string" \
--PolicyName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (CreatePolicyRequest):
Body Parameter | Type | Description |
---|---|---|
Description | string | A friendly description of the policy, in which you can write information about the permissions contained in the policy. |
Path | string | The path to the policy. |
PolicyDocument (required) | string | The policy document, corresponding to a JSON string that contains the policy. This policy document can contain a maximum of 5120 non-whitespace characters. For more information, see EIM Reference Information and EIM Policy Generator. |
PolicyName (required) | string | The name of the policy. |
Response Elements
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"
}
}
Response 200 (CreatePolicyResponse):
Response Element | Type | Description |
---|---|---|
Policy | Policy | Information about the newly created policy. |
Arn | string | The unique identifier of the resource (between 20 and 2048 characters). |
AttachmentCount | integer | The number of resources attached to the policy. |
CreateDate | string | The date and time of creation of the policy, in ISO 8601 format. |
DefaultVersionId | string | The ID of the policy default version. |
Description | string | A friendly name for the policy (between 0 and 1000 characters). |
IsAttachable | boolean | Indicates whether the policy can be attached to a group or an EIM user. |
Path | string | The path to the policy. |
PolicyId | string | The ID of the policy (between 16 and 32 characters). |
PolicyName | string | The name of the policy (between 1 and 128 characters). |
UpdateDate | string | The date and time when the policy was last updated, in ISO 8601 format. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
CreatePolicyVersion
POST /CreatePolicyVersion
Creates a version of a specified managed policy.
A managed policy can have up to five versions.
This AWS-compliant method corresponds to CreatePolicyVersion in the OUTSCALE API.
Request Parameters
osc-cli eim CreatePolicyVersion --profile "default" \
--PolicyArn "string" \
--PolicyDocument "string" \
--SetAsDefault True
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (CreatePolicyVersionRequest):
Body Parameter | Type | Description |
---|---|---|
PolicyArn (required) | string | The OUTSCALE Resource Name (ORN) of the policy. For more information, see Resource Identifiers. |
PolicyDocument (required) | string | The policy document, corresponding to a JSON string that contains the new version of the policy. This policy document can contain a maximum of 5120 non-whitespace characters. For more information, see EIM Reference Information and EIM Policy Generator. |
SetAsDefault | boolean | If set to true, the new policy version is the default version and becomes the operative one. |
Response Elements
200 Response
{
"PolicyVersion": {
"CreateDate": "string",
"Document": "string",
"IsDefaultVersion": true,
"VersionId": "string"
},
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (CreatePolicyVersionResponse):
Response Element | Type | Description |
---|---|---|
PolicyVersion | PolicyVersion | Information about the policy version. |
CreateDate | string | The date of the creation of the version. |
Document | string | The policy document as a json string. |
IsDefaultVersion | boolean | If true, the version is the default one. |
VersionId | string | The ID of the version. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
DeleteGroupPolicy
POST /DeleteGroupPolicy
Deletes a specified inline policy from a specific group.
This AWS-compliant method corresponds to DeleteUserGroupPolicy in the OUTSCALE API.
Request Parameters
osc-cli eim DeleteGroupPolicy --profile "default" \
--GroupName "string" \
--PolicyName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (DeleteGroupPolicyRequest):
Body Parameter | Type | Description |
---|---|---|
GroupName (required) | string | The friendly name of the group (between 1 and 128 characters). |
PolicyName (required) | string | The name of the policy document you want to delete (between 1 and 128 characters). |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (DeleteGroupPolicyResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
DeletePolicy
POST /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.
This AWS-compliant method corresponds to DeletePolicy in the OUTSCALE API.
Request Parameters
osc-cli eim DeletePolicy --profile "default" \
--PolicyArn "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (DeletePolicyRequest):
Body Parameter | Type | Description |
---|---|---|
PolicyArn (required) | string | The unique resource identifier of the policy you want to delete. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (DeletePolicyResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
DeletePolicyVersion
POST /DeletePolicyVersion
Deletes a specified version of a managed policy, if it not set as the default one.
This AWS-compliant method corresponds to DeletePolicyVersion in the OUTSCALE API.
Request Parameters
osc-cli eim DeletePolicyVersion --profile "default" \
--PolicyArn "string" \
--VersionId "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (DeletePolicyVersionRequest):
Body Parameter | Type | Description |
---|---|---|
PolicyArn (required) | string | The unique identifier (ARN) of the policy. |
VersionId (required) | string | The ID of the version. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (DeletePolicyVersionResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
DeleteUserPolicy
POST /DeleteUserPolicy
Deletes a specified inline policy from a specific user.
Request Parameters
osc-cli eim DeleteUserPolicy --profile "default" \
--PolicyName "string" \
--UserName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (DeleteUserPolicyRequest):
Body Parameter | Type | Description |
---|---|---|
PolicyName (required) | string | The name of the policy document you want to delete (between 1 and 128 characters). |
UserName (required) | string | The friendly name of the user (between 1 and 64 characters). |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (DeleteUserPolicyResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
DetachGroupPolicy
POST /DetachGroupPolicy
Removes a managed policy from a specific group.
This AWS-compliant method corresponds to UnlinkManagedPolicyFromUserGroup in the OUTSCALE API.
Request Parameters
osc-cli eim DetachGroupPolicy --profile "default" \
--GroupName "string" \
--PolicyArn "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (DetachGroupPolicyRequest):
Body Parameter | Type | Description |
---|---|---|
GroupName (required) | string | The friendly name of the group you want to detach the policy from (length between 1 and 128). |
PolicyArn (required) | string | The unique resource identifier for the policy (between 20 and 2048 characters). |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (DetachGroupPolicyResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
DetachUserPolicy
POST /DetachUserPolicy
Removes a managed policy from a specific user.
This AWS-compliant method corresponds to UnlinkPolicy in the OUTSCALE API.
Request Parameters
osc-cli eim DetachUserPolicy --profile "default" \
--PolicyArn "string" \
--UserName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (DetachUserPolicyRequest):
Body Parameter | Type | Description |
---|---|---|
PolicyArn (required) | string | The unique resource identifier for the policy (between 20 and 2048 characters). |
UserName (required) | string | The friendly name of the user you want to detach the policy from (length between 1 and 64). |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (DetachUserPolicyResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
GetGroupPolicy
POST /GetGroupPolicy
Returns information about an inline policy included in a specified group.
This AWS-compliant method corresponds to ReadUserGroupPolicy in the OUTSCALE API.
Request Parameters
osc-cli eim GetGroupPolicy --profile "default" \
--GroupName "string" \
--PolicyName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (GetGroupPolicyRequest):
Body Parameter | Type | Description |
---|---|---|
GroupName (required) | string | The name of the group (between 1 and 128 characters). |
PolicyName (required) | string | The name of the policy (between 1 and 128 characters). |
Response Elements
200 Response
{
"GroupName": "string",
"PolicyDocument": "string",
"PolicyName": "string",
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (GetGroupPolicyResponse):
Response Element | Type | Description |
---|---|---|
GroupName | string | The name of the group in which the inline policy is included. |
PolicyDocument | string | The policy document, providing a description of the policy. |
PolicyName | string | The name of the inline policy. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
GetPolicy
POST /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.
This AWS-compliant method corresponds to ReadPolicy in the OUTSCALE API.
Request Parameters
osc-cli eim GetPolicy --profile "default" \
--PolicyArn "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (GetPolicyRequest):
Body Parameter | Type | Description |
---|---|---|
PolicyArn (required) | string | The unique resource identifier for the policy. |
Response Elements
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"
}
}
Response 200 (GetPolicyResponse):
Response Element | Type | Description |
---|---|---|
Policy | Policy | Information about the newly created policy. |
Arn | string | The unique identifier of the resource (between 20 and 2048 characters). |
AttachmentCount | integer | The number of resources attached to the policy. |
CreateDate | string | The date and time of creation of the policy, in ISO 8601 format. |
DefaultVersionId | string | The ID of the policy default version. |
Description | string | A friendly name for the policy (between 0 and 1000 characters). |
IsAttachable | boolean | Indicates whether the policy can be attached to a group or an EIM user. |
Path | string | The path to the policy. |
PolicyId | string | The ID of the policy (between 16 and 32 characters). |
PolicyName | string | The name of the policy (between 1 and 128 characters). |
UpdateDate | string | The date and time when the policy was last updated, in ISO 8601 format. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
GetPolicyVersion
POST /GetPolicyVersion
Gets information about a specified version of a managed policy.
This AWS-compliant method corresponds to ReadPolicyVersion in the OUTSCALE API.
Request Parameters
osc-cli eim GetPolicyVersion --profile "default" \
--PolicyArn "string" \
--VersionId "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (GetPolicyVersionRequest):
Body Parameter | Type | Description |
---|---|---|
PolicyArn (required) | string | The unique identifier (ARN) of the policy. |
VersionId (required) | string | The ID of the version. |
Response Elements
200 Response
{
"PolicyVersion": {
"CreateDate": "string",
"Document": "string",
"IsDefaultVersion": true,
"VersionId": "string"
},
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (GetPolicyVersionResponse):
Response Element | Type | Description |
---|---|---|
PolicyVersion | PolicyVersion | Information about the policy version. |
CreateDate | string | The date of the creation of the version. |
Document | string | The policy document as a json string. |
IsDefaultVersion | boolean | If true, the version is the default one. |
VersionId | string | The ID of the version. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
GetUserPolicy
POST /GetUserPolicy
Returns information about an inline policy included in a specified user.
Request Parameters
osc-cli eim GetUserPolicy --profile "default" \
--PolicyName "string" \
--UserName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (GetUserPolicyRequest):
Body Parameter | Type | Description |
---|---|---|
PolicyName (required) | string | The name of the policy (between 1 and 128 characters). |
UserName (required) | string | The name of the user (between 1 and 64 characters). |
Response Elements
200 Response
{
"PolicyDocument": "string",
"PolicyName": "string",
"ResponseMetadata": {
"RequestId": "string"
},
"UserName": "string"
}
Response 200 (GetUserPolicyResponse):
Response Element | Type | Description |
---|---|---|
PolicyDocument | string | The policy document, providing a description of the policy. |
PolicyName | string | The name of the inline policy. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
UserName | string | The name of the user in which the inline policy is included. |
ListAttachedGroupPolicies
POST /ListAttachedGroupPolicies
Lists the managed policies attached to a specified group.
This AWS-compliant method corresponds to ReadManagedPoliciesLinkedToUserGroup in the OUTSCALE API.
Request Parameters
osc-cli eim ListAttachedGroupPolicies --profile "default" \
--GroupName "string" \
--Marker "string" \
--MaxItems 0 \
--PathPrefix "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (ListAttachedGroupPoliciesRequest):
Body Parameter | Type | Description |
---|---|---|
GroupName (required) | string | The name of the group. |
Marker | string | The marker to request the next results page. |
MaxItems | integer | The maximum number of items that can be returned in a single page (by default, 100 ). |
PathPrefix | string | The path prefix of the policies, set to a slash (/ ) if not specified. |
Response Elements
200 Response
{
"AttachedPolicies": [
{
"PolicyArn": "string",
"PolicyName": "string"
}
],
"IsTruncated": true,
"Marker": "string",
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (ListAttachedGroupPoliciesResponse):
Response Element | Type | Description |
---|---|---|
AttachedPolicies | [AttachedPolicies] | One or more policies attached to the specified group. |
PolicyArn | string | The unique identifier of the policy (between 20 and 2048 characters). |
PolicyName | string | The name of the attached policy (between 1 and 128 characters). |
IsTruncated | boolean | If true, there are more items to return using the marker in a new request. |
Marker | string | The marker to request the next results page. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
ListAttachedUserPolicies
POST /ListAttachedUserPolicies
Lists the managed policies attached to a specified user.
This AWS-compliant method corresponds to ReadLinkedPolicies in the OUTSCALE API.
Request Parameters
osc-cli eim ListAttachedUserPolicies --profile "default" \
--Marker "string" \
--MaxItems 0 \
--PathPrefix "string" \
--UserName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (ListAttachedUserPoliciesRequest):
Body Parameter | Type | Description |
---|---|---|
Marker | string | The marker to request the next results page. |
MaxItems | integer | The maximum number of items that can be returned in a single page (by default, 100 ). |
PathPrefix | string | The path prefix of the policies, set to a slash (/ ) if not specified. |
UserName (required) | string | The name of the user. |
Response Elements
200 Response
{
"AttachedPolicies": [
{
"PolicyArn": "string",
"PolicyName": "string"
}
],
"IsTruncated": true,
"Marker": "string",
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (ListAttachedUserPoliciesResponse):
Response Element | Type | Description |
---|---|---|
AttachedPolicies | [AttachedPolicies] | One or more policies attached to the specified user. |
PolicyArn | string | The unique identifier of the policy (between 20 and 2048 characters). |
PolicyName | string | The name of the attached policy (between 1 and 128 characters). |
IsTruncated | boolean | If true, there are more items to return using the marker in a new request. |
Marker | string | The marker to request the next results page. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
ListGroupPolicies
POST /ListGroupPolicies
Lists the names of the inline policies embedded in a specific group.
This AWS-compliant method corresponds to ReadUserGroupPolicies in the OUTSCALE API.
Request Parameters
osc-cli eim ListGroupPolicies --profile "default" \
--GroupName "string" \
--Marker "string" \
--MaxItems 0
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (ListGroupPoliciesRequest):
Body Parameter | Type | Description |
---|---|---|
GroupName (required) | string | The name of the group. |
Marker | string | The marker to request the next results page. |
MaxItems | integer | The maximum number of items that can be returned in a single page (by default, 100 ). |
Response Elements
200 Response
{
"IsTruncated": true,
"Marker": "string",
"PolicyNames": [
"string"
],
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (ListGroupPoliciesResponse):
Response Element | Type | Description |
---|---|---|
IsTruncated | boolean | If true, there are more items to return using the marker in a new request. |
Marker | string | The marker to request the next results page. |
PolicyNames | [string] | One or more policy names. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
ListPolicies
POST /ListPolicies
Lists all the managed policies available for your account.
This AWS-compliant method corresponds to ReadPolicies in the OUTSCALE API.
Request Parameters
osc-cli eim ListPolicies --profile "default" \
--Marker "string" \
--MaxItems 0 \
--OnlyAttached True \
--PathPrefix "string" \
--Scope "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (ListPoliciesRequest):
Body Parameter | Type | Description |
---|---|---|
Marker | string | The marker to request the next results page. |
MaxItems | integer | The maximum number of items that can be returned in a single page (by default, 100 ). |
OnlyAttached | boolean | If set to true, lists only the policies attached to a user or a group. |
PathPrefix | string | The path prefix you can use to filter the results, set to a slash (/ ) by default. |
Scope | string | The scope to filter policies (ALL | OWS | local ). |
Response Elements
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"
}
}
Response 200 (ListPoliciesResponse):
Response Element | Type | Description |
---|---|---|
IsTruncated | boolean | If true, there are more items to return using the marker in a new request. |
Marker | string | The marker to request the next results page. |
Policies | [Policies] | Information about one or more policies. |
Arn | string | The unique identifier of the resource (between 20 and 2048 characters). |
AttachmentCount | integer | The number of resources attached to the policy. |
CreateDate | string | The date and time of creation of the policy, in ISO 8601 format. |
DefaultVersionId | string | The ID of the policy default version. |
Description | string | A friendly name for the policy (between 0 and 1000 characters). |
IsAttachable | boolean | Indicates whether the policy can be attached to a group or an EIM user. |
Path | string | The path to the policy. |
PolicyId | string | The ID of the policy (between 16 and 32 characters). |
PolicyName | string | The name of the policy (between 1 and 128 characters). |
UpdateDate | string | The date and time when the policy was last updated, in ISO 8601 format. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
ListPolicyVersions
POST /ListPolicyVersions
Lists information about all the policy versions of a specified managed policy.
This AWS-compliant method corresponds to ReadPolicyVersions in the OUTSCALE API.
Request Parameters
osc-cli eim ListPolicyVersions --profile "default" \
--Marker "string" \
--MaxItems 0 \
--PolicyArn "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (ListPolicyVersionsRequest):
Body Parameter | Type | Description |
---|---|---|
Marker | string | The marker to request the next results page. |
MaxItems | integer | The maximum number of items that can be returned in a single page (by default, 100 ). |
PolicyArn (required) | string | The OUTSCALE Resource Name (ORN) of the policy. |
Response Elements
200 Response
{
"IsTruncated": true,
"Marker": "string",
"ResponseMetadata": {
"RequestId": "string"
},
"Versions": [
{
"CreateDate": "string",
"Document": "string",
"IsDefaultVersion": true,
"VersionId": "string"
}
]
}
Response 200 (ListPolicyVersionsResponse):
Response Element | Type | Description |
---|---|---|
IsTruncated | boolean | If true, there are more items to return using the marker in a new request. |
Marker | string | The marker to request the next results page. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
Versions | [Versions] | A list of all the versions of the policy. |
CreateDate | string | The date of the creation of the version. |
Document | string | The policy document as a json string. |
IsDefaultVersion | boolean | If true, the version is the default one. |
VersionId | string | The ID of the version. |
ListUserPolicies
POST /ListUserPolicies
Lists the names of inline policies included in a specified user.
Request Parameters
osc-cli eim ListUserPolicies --profile "default" \
--UserName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (ListUserPoliciesRequest):
Body Parameter | Type | Description |
---|---|---|
UserName (required) | string | The name of the user. |
Response Elements
200 Response
{
"ListUserPoliciesResult": {
"PolicyNames": "string"
},
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (ListUserPoliciesResponse):
Response Element | Type | Description |
---|---|---|
ListUserPoliciesResult | ListUserPoliciesResult | Information about one or more user policies. |
PolicyNames | string | A list of policy names. |
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
PutGroupPolicy
POST /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.
This AWS-compliant method corresponds to PutUserGroupPolicy in the OUTSCALE API.
Request Parameters
osc-cli eim PutGroupPolicy --profile "default" \
--GroupName "string" \
--PolicyDocument "string" \
--PolicyName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (PutGroupPolicyRequest):
Body Parameter | Type | Description |
---|---|---|
GroupName (required) | string | The name of the group. |
PolicyDocument (required) | string | The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information and EIM Policy Generator. |
PolicyName (required) | string | The name of the policy. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (PutGroupPolicyResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
PutUserPolicy
POST /PutUserPolicy
Creates or updates an inline policy included in a specified user.
The policy is automatically applied to the user after its creation.
Request Parameters
osc-cli eim PutUserPolicy --profile "default" \
--PolicyDocument "string" \
--PolicyName "string" \
--UserName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (PutUserPolicyRequest):
Body Parameter | Type | Description |
---|---|---|
PolicyDocument (required) | string | The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information and EIM Policy Generator. |
PolicyName (required) | string | The name of the policy. |
UserName (required) | string | The name of the user. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (PutUserPolicyResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
SetDefaultPolicyVersion
POST /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.
This AWS-compliant method corresponds to SetDefaultPolicyVersion in the OUTSCALE API.
Request Parameters
osc-cli eim SetDefaultPolicyVersion --profile "default" \
--PolicyArn "string" \
--VersionId "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (SetDefaultPolicyVersionRequest):
Body Parameter | Type | Description |
---|---|---|
PolicyArn (required) | string | The unique identifier (ARN) of the policy. |
VersionId (required) | string | The ID of the version. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (SetDefaultPolicyVersionResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
Users
CreateUser
POST /CreateUser
Creates a user for your account.
For more information, see About EIM Users.
This AWS-compliant method corresponds to CreateUser in the OUTSCALE API.
Request Parameters
osc-cli eim CreateUser --profile "default" \
--Path "string" \
--UserName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (CreateUserRequest):
Body Parameter | Type | Description |
---|---|---|
Path | string | The path for the user name. If you do not specify a path, it is set to a slash (/ ). |
UserName (required) | string | The name of the user to be created. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
},
"User": {
"Arn": "string",
"CreateDate": "string",
"PasswordLastUsed": "string",
"Path": "string",
"UserId": "string",
"UserName": "string"
}
}
Response 200 (CreateUserResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
User | User | Information about the newly created user. |
Arn | string | The unique identifier of the user (between 20 and 2048 characters). |
CreateDate | string | The date and time of creation of the user, in ISO 8601 format. |
PasswordLastUsed | string | The date and time when the user's password was last used, in ISO 8601 format. |
Path | string | The path to the user. |
UserId | string | The ID of the user. |
UserName | string | The name of the user. |
DeleteUser
POST /DeleteUser
Deletes a specified user.
The user must not belong to any group, nor have any key or attached policy.
This AWS-compliant method corresponds to DeleteUser in the OUTSCALE API.
Request Parameters
osc-cli eim DeleteUser --profile "default" \
--UserName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (DeleteUserRequest):
Body Parameter | Type | Description |
---|---|---|
UserName (required) | string | The name of the user you want to delete. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (DeleteUserResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
GetUser
POST /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.
This AWS-compliant method corresponds to ReadUsers in the OUTSCALE API.
Request Parameters
osc-cli eim GetUser --profile "default" \
--UserName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (GetUserRequest):
Body Parameter | Type | Description |
---|---|---|
UserName | string | The name of the user. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
},
"User": {
"Arn": "string",
"CreateDate": "string",
"PasswordLastUsed": "string",
"Path": "string",
"UserId": "string",
"UserName": "string"
}
}
Response 200 (GetUserResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
User | User | Information about the newly created user. |
Arn | string | The unique identifier of the user (between 20 and 2048 characters). |
CreateDate | string | The date and time of creation of the user, in ISO 8601 format. |
PasswordLastUsed | string | The date and time when the user's password was last used, in ISO 8601 format. |
Path | string | The path to the user. |
UserId | string | The ID of the user. |
UserName | string | The name of the user. |
ListUsers
POST /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).
This AWS-compliant method corresponds to ReadUsers in the OUTSCALE API.
Request Parameters
osc-cli eim ListUsers --profile "default" \
--PathPrefix "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (ListUsersRequest):
Body Parameter | Type | Description |
---|---|---|
PathPrefix | string | The path prefix. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
},
"Users": [
{
"Arn": "string",
"CreateDate": "string",
"PasswordLastUsed": "string",
"Path": "string",
"UserId": "string",
"UserName": "string"
}
]
}
Response 200 (ListUsersResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
Users | [Users] | A list of users. |
Arn | string | The unique identifier of the user (between 20 and 2048 characters). |
CreateDate | string | The date and time of creation of the user, in ISO 8601 format. |
PasswordLastUsed | string | The date and time when the user's password was last used, in ISO 8601 format. |
Path | string | The path to the user. |
UserId | string | The ID of the user. |
UserName | string | The name of the user. |
UpdateUser
POST /UpdateUser
Modifies the name and/or the path of a specified user.
This AWS-compliant method corresponds to UpdateUser in the OUTSCALE API.
Request Parameters
osc-cli eim UpdateUser --profile "default" \
--NewPath "string" \
--NewUserName "string" \
--UserName "string"
# You need Curl version 7.75 or later to use the --aws-sigv4 option
curl -X POST 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'
Body (UpdateUserRequest):
Body Parameter | Type | Description |
---|---|---|
NewPath | string | A new path for the user. |
NewUserName | string | A new name for the user. |
UserName (required) | string | The name of the user you want to modify. |
Response Elements
200 Response
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Response 200 (UpdateUserResponse):
Response Element | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
RequestId | string | The ID of the request. |
Schemas
AccessKey
Information about the access key.
Property | Type | Description |
---|---|---|
AccessKeyId | string | The ID of the access key. |
CreateDate | string | The date of the creation of the access key. |
SecretAccessKey | string | The secret key that enables you to send requests. |
Status | string | The state of the access key (Active if the key is valid for API calls, or Inactive if not). |
UserName | string | 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.
Property | Type | Description |
---|---|---|
AccessKeyId | string | The ID of the access key. |
CreateDate | string | The date of the creation of the access key. |
Status | string | The state of the access key (Active if the key is valid for API calls, or Inactive if not). |
UserName | string | The name of the user the access key is associated with. |
Schema
{
"AccessKeyId": "string",
"CreateDate": "string",
"Status": "string",
"UserName": "string"
}
AddUserToGroupRequest
Property | Type | Description |
---|---|---|
GroupName | string | The name of the group you want to add a user to. |
UserName | string | The name of the user you want to add to the group. |
Schema
{
"GroupName": "string",
"UserName": "string"
}
AddUserToGroupResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
AttachGroupPolicyRequest
Property | Type | Description |
---|---|---|
GroupName | string | The friendly name given to the group you want to attach the policy to (between 1 and 128 characters). |
PolicyArn | string | The unique resource identifier for the policy (between 20 and 2048 characters). |
Schema
{
"GroupName": "string",
"PolicyArn": "string"
}
AttachGroupPolicyResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
AttachUserPolicyRequest
Property | Type | Description |
---|---|---|
PolicyArn | string | The unique resource identifier for the policy (between 20 and 2048 characters). |
UserName | string | The friendly name of the user you want to attach the policy to (between 1 and 64 characters). |
Schema
{
"PolicyArn": "string",
"UserName": "string"
}
AttachUserPolicyResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
AttachedPolicies
One or more policies attached to the specified user.
Property | Type | Description |
---|---|---|
PolicyArn | string | The unique identifier of the policy (between 20 and 2048 characters). |
PolicyName | string | The name of the attached policy (between 1 and 128 characters). |
Schema
{
"PolicyArn": "string",
"PolicyName": "string"
}
CreateAccessKeyRequest
Property | Type | Description |
---|---|---|
UserName | string | 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. |
Schema
{
"UserName": "string"
}
CreateAccessKeyResponse
Property | Type | Description |
---|---|---|
AccessKey | AccessKey | Information about the access key. |
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"AccessKey": {
"AccessKeyId": "string",
"CreateDate": "string",
"SecretAccessKey": "string",
"Status": "string",
"UserName": "string"
},
"ResponseMetadata": {
"RequestId": "string"
}
}
CreateGroupRequest
Property | Type | Description |
---|---|---|
GroupName | string | The name of the group to be created. |
Path | string | The path to the group, set to a slash (/ ) if not specified. |
Schema
{
"GroupName": "string",
"Path": "string"
}
CreateGroupResponse
Property | Type | Description |
---|---|---|
Group | Group | Information about the newly created group. |
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"Group": {
"Arn": "string",
"CreateDate": "string",
"GroupId": "string",
"GroupName": "string",
"Path": "string"
},
"ResponseMetadata": {
"RequestId": "string"
}
}
CreatePolicyRequest
Property | Type | Description |
---|---|---|
Description | string | A friendly description of the policy, in which you can write information about the permissions contained in the policy. |
Path | string | The path to the policy. |
PolicyDocument | string | The policy document, corresponding to a JSON string that contains the policy. This policy document can contain a maximum of 5120 non-whitespace characters. For more information, see EIM Reference Information and EIM Policy Generator. |
PolicyName | string | The name of the policy. |
Schema
{
"Description": "string",
"Path": "string",
"PolicyDocument": "string",
"PolicyName": "string"
}
CreatePolicyResponse
Property | Type | Description |
---|---|---|
Policy | Policy | Information about the newly created policy. |
ResponseMetadata | ResponseMetadata | 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"
}
}
CreatePolicyVersionRequest
Property | Type | Description |
---|---|---|
PolicyArn | string | The OUTSCALE Resource Name (ORN) of the policy. For more information, see Resource Identifiers. |
PolicyDocument | string | The policy document, corresponding to a JSON string that contains the new version of the policy. This policy document can contain a maximum of 5120 non-whitespace characters. For more information, see EIM Reference Information and EIM Policy Generator. |
SetAsDefault | boolean | If set to true, the new policy version is the default version and becomes the operative one. |
Schema
{
"PolicyArn": "string",
"PolicyDocument": "string",
"SetAsDefault": true
}
CreatePolicyVersionResponse
Property | Type | Description |
---|---|---|
PolicyVersion | PolicyVersion | Information about the policy version. |
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"PolicyVersion": {
"CreateDate": "string",
"Document": "string",
"IsDefaultVersion": true,
"VersionId": "string"
},
"ResponseMetadata": {
"RequestId": "string"
}
}
CreateUserRequest
Property | Type | Description |
---|---|---|
Path | string | The path for the user name. If you do not specify a path, it is set to a slash (/ ). |
UserName | string | The name of the user to be created. |
Schema
{
"Path": "string",
"UserName": "string"
}
CreateUserResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
User | User | Information about the newly created user. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
},
"User": {
"Arn": "string",
"CreateDate": "string",
"PasswordLastUsed": "string",
"Path": "string",
"UserId": "string",
"UserName": "string"
}
}
DeleteAccessKeyRequest
Property | Type | Description |
---|---|---|
AccessKeyId | string | The ID of the access key you want to delete. |
UserName | string | The user name the access key you want to delete is associated with. By default, the user who sends the request. |
Schema
{
"AccessKeyId": "string",
"UserName": "string"
}
DeleteAccessKeyResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
DeleteGroupPolicyRequest
Property | Type | Description |
---|---|---|
GroupName | string | The friendly name of the group (between 1 and 128 characters). |
PolicyName | string | The name of the policy document you want to delete (between 1 and 128 characters). |
Schema
{
"GroupName": "string",
"PolicyName": "string"
}
DeleteGroupPolicyResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
DeleteGroupRequest
Property | Type | Description |
---|---|---|
GroupName | string | The name of the group you want to delete. |
Schema
{
"GroupName": "string"
}
DeleteGroupResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
DeletePolicyRequest
Property | Type | Description |
---|---|---|
PolicyArn | string | The unique resource identifier of the policy you want to delete. |
Schema
{
"PolicyArn": "string"
}
DeletePolicyResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
DeletePolicyVersionRequest
Property | Type | Description |
---|---|---|
PolicyArn | string | The unique identifier (ARN) of the policy. |
VersionId | string | The ID of the version. |
Schema
{
"PolicyArn": "string",
"VersionId": "string"
}
DeletePolicyVersionResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
DeleteServerCertificateRequest
Property | Type | Description |
---|---|---|
ServerCertificateName | string | The name of the server certificate you want to delete. |
Schema
{
"ServerCertificateName": "string"
}
DeleteServerCertificateResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
DeleteUserPolicyRequest
Property | Type | Description |
---|---|---|
PolicyName | string | The name of the policy document you want to delete (between 1 and 128 characters). |
UserName | string | The friendly name of the user (between 1 and 64 characters). |
Schema
{
"PolicyName": "string",
"UserName": "string"
}
DeleteUserPolicyResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
DeleteUserRequest
Property | Type | Description |
---|---|---|
UserName | string | The name of the user you want to delete. |
Schema
{
"UserName": "string"
}
DeleteUserResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
DetachGroupPolicyRequest
Property | Type | Description |
---|---|---|
GroupName | string | The friendly name of the group you want to detach the policy from (length between 1 and 128). |
PolicyArn | string | The unique resource identifier for the policy (between 20 and 2048 characters). |
Schema
{
"GroupName": "string",
"PolicyArn": "string"
}
DetachGroupPolicyResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
DetachUserPolicyRequest
Property | Type | Description |
---|---|---|
PolicyArn | string | The unique resource identifier for the policy (between 20 and 2048 characters). |
UserName | string | The friendly name of the user you want to detach the policy from (length between 1 and 64). |
Schema
{
"PolicyArn": "string",
"UserName": "string"
}
DetachUserPolicyResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
GetGroupPolicyRequest
Property | Type | Description |
---|---|---|
GroupName | string | The name of the group (between 1 and 128 characters). |
PolicyName | string | The name of the policy (between 1 and 128 characters). |
Schema
{
"GroupName": "string",
"PolicyName": "string"
}
GetGroupPolicyResponse
Property | Type | Description |
---|---|---|
GroupName | string | The name of the group in which the inline policy is included. |
PolicyDocument | string | The policy document, providing a description of the policy. |
PolicyName | string | The name of the inline policy. |
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"GroupName": "string",
"PolicyDocument": "string",
"PolicyName": "string",
"ResponseMetadata": {
"RequestId": "string"
}
}
GetGroupRequest
Property | Type | Description |
---|---|---|
GroupName | string | The name of the group. |
Schema
{
"GroupName": "string"
}
GetGroupResponse
Property | Type | Description |
---|---|---|
Group | Group | Information about the newly created group. |
ResponseMetadata | ResponseMetadata | Information about the response. |
Users | [Users] | 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"
}
]
}
GetPolicyRequest
Property | Type | Description |
---|---|---|
PolicyArn | string | The unique resource identifier for the policy. |
Schema
{
"PolicyArn": "string"
}
GetPolicyResponse
Property | Type | Description |
---|---|---|
Policy | Policy | Information about the newly created policy. |
ResponseMetadata | ResponseMetadata | 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"
}
}
GetPolicyVersionRequest
Property | Type | Description |
---|---|---|
PolicyArn | string | The unique identifier (ARN) of the policy. |
VersionId | string | The ID of the version. |
Schema
{
"PolicyArn": "string",
"VersionId": "string"
}
GetPolicyVersionResponse
Property | Type | Description |
---|---|---|
PolicyVersion | PolicyVersion | Information about the policy version. |
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"PolicyVersion": {
"CreateDate": "string",
"Document": "string",
"IsDefaultVersion": true,
"VersionId": "string"
},
"ResponseMetadata": {
"RequestId": "string"
}
}
GetServerCertificateRequest
Property | Type | Description |
---|---|---|
ServerCertificateName | string | The name of the server certificate you want information about. |
Schema
{
"ServerCertificateName": "string"
}
GetServerCertificateResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
ServerCertificate | ServerCertificate | 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"
}
}
}
GetUserPolicyRequest
Property | Type | Description |
---|---|---|
PolicyName | string | The name of the policy (between 1 and 128 characters). |
UserName | string | The name of the user (between 1 and 64 characters). |
Schema
{
"PolicyName": "string",
"UserName": "string"
}
GetUserPolicyResponse
Property | Type | Description |
---|---|---|
PolicyDocument | string | The policy document, providing a description of the policy. |
PolicyName | string | The name of the inline policy. |
ResponseMetadata | ResponseMetadata | Information about the response. |
UserName | string | The name of the user in which the inline policy is included. |
Schema
{
"PolicyDocument": "string",
"PolicyName": "string",
"ResponseMetadata": {
"RequestId": "string"
},
"UserName": "string"
}
GetUserRequest
Property | Type | Description |
---|---|---|
UserName | string | The name of the user. |
Schema
{
"UserName": "string"
}
GetUserResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
User | User | 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.
Property | Type | Description |
---|---|---|
Arn | string | The unique identifier of the group (between 20 and 2048 characters). |
CreateDate | string | The date and time of creation of the group, in ISO 8601 format. |
GroupId | string | The ID of the group. |
GroupName | string | The name of the group. |
Path | string | 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.
Property | Type | Description |
---|---|---|
Arn | string | The unique identifier of the group (between 20 and 2048 characters). |
CreateDate | string | The date and time of creation of the group, in ISO 8601 format. |
GroupId | string | The ID of the group. |
GroupName | string | The name of the group. |
Path | string | The path to the group. |
Schema
{
"Arn": "string",
"CreateDate": "string",
"GroupId": "string",
"GroupName": "string",
"Path": "string"
}
ListAccessKeysRequest
Property | Type | Description |
---|---|---|
Marker | string | The marker to request the next results page. |
MaxItems | integer | The maximum number of items that can be returned in a single page (by default, 100 ). |
UserName | string | The name of the user. By default, the user who sends the request. |
Schema
{
"Marker": "string",
"MaxItems": 0,
"UserName": "string"
}
ListAccessKeysResponse
Property | Type | Description |
---|---|---|
AccessKeyMetadata | [AccessKeyMetadata] | A list of access keys and their metadata. |
IsTruncated | boolean | If true, there are more items to return using the marker in a new request. |
Marker | string | The marker to request the next results page. |
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"AccessKeyMetadata": [
{
"AccessKeyId": "string",
"CreateDate": "string",
"Status": "string",
"UserName": "string"
}
],
"IsTruncated": true,
"Marker": "string",
"ResponseMetadata": {
"RequestId": "string"
}
}
ListAttachedGroupPoliciesRequest
Property | Type | Description |
---|---|---|
GroupName | string | The name of the group. |
Marker | string | The marker to request the next results page. |
MaxItems | integer | The maximum number of items that can be returned in a single page (by default, 100 ). |
PathPrefix | string | The path prefix of the policies, set to a slash (/ ) if not specified. |
Schema
{
"GroupName": "string",
"Marker": "string",
"MaxItems": 0,
"PathPrefix": "string"
}
ListAttachedGroupPoliciesResponse
Property | Type | Description |
---|---|---|
AttachedPolicies | [AttachedPolicies] | One or more policies attached to the specified group. |
IsTruncated | boolean | If true, there are more items to return using the marker in a new request. |
Marker | string | The marker to request the next results page. |
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"AttachedPolicies": [
{
"PolicyArn": "string",
"PolicyName": "string"
}
],
"IsTruncated": true,
"Marker": "string",
"ResponseMetadata": {
"RequestId": "string"
}
}
ListAttachedUserPoliciesRequest
Property | Type | Description |
---|---|---|
Marker | string | The marker to request the next results page. |
MaxItems | integer | The maximum number of items that can be returned in a single page (by default, 100 ). |
PathPrefix | string | The path prefix of the policies, set to a slash (/ ) if not specified. |
UserName | string | The name of the user. |
Schema
{
"Marker": "string",
"MaxItems": 0,
"PathPrefix": "string",
"UserName": "string"
}
ListAttachedUserPoliciesResponse
Property | Type | Description |
---|---|---|
AttachedPolicies | [AttachedPolicies] | One or more policies attached to the specified user. |
IsTruncated | boolean | If true, there are more items to return using the marker in a new request. |
Marker | string | The marker to request the next results page. |
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"AttachedPolicies": [
{
"PolicyArn": "string",
"PolicyName": "string"
}
],
"IsTruncated": true,
"Marker": "string",
"ResponseMetadata": {
"RequestId": "string"
}
}
ListGroupPoliciesRequest
Property | Type | Description |
---|---|---|
GroupName | string | The name of the group. |
Marker | string | The marker to request the next results page. |
MaxItems | integer | The maximum number of items that can be returned in a single page (by default, 100 ). |
Schema
{
"GroupName": "string",
"Marker": "string",
"MaxItems": 0
}
ListGroupPoliciesResponse
Property | Type | Description |
---|---|---|
IsTruncated | boolean | If true, there are more items to return using the marker in a new request. |
Marker | string | The marker to request the next results page. |
PolicyNames | [string] | One or more policy names. |
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"IsTruncated": true,
"Marker": "string",
"PolicyNames": [
"string"
],
"ResponseMetadata": {
"RequestId": "string"
}
}
ListGroupsForUserRequest
Property | Type | Description |
---|---|---|
UserName | string | The name of the user. |
Schema
{
"UserName": "string"
}
ListGroupsForUserResponse
Property | Type | Description |
---|---|---|
Groups | [Groups] | One or more groups the specified user belongs to. |
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"Groups": [
{
"Arn": "string",
"CreateDate": "string",
"GroupId": "string",
"GroupName": "string",
"Path": "string"
}
],
"ResponseMetadata": {
"RequestId": "string"
}
}
ListGroupsRequest
Property | Type | Description |
---|---|---|
PathPrefix | string | The path prefix with which you want to filter the results. If not specified, it is set to a slash (/ ). |
Schema
{
"PathPrefix": "string"
}
ListGroupsResponse
Property | Type | Description |
---|---|---|
Groups | [Groups] | One or more groups with the specified path prefix. |
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"Groups": [
{
"Arn": "string",
"CreateDate": "string",
"GroupId": "string",
"GroupName": "string",
"Path": "string"
}
],
"ResponseMetadata": {
"RequestId": "string"
}
}
ListPoliciesRequest
Property | Type | Description |
---|---|---|
Marker | string | The marker to request the next results page. |
MaxItems | integer | The maximum number of items that can be returned in a single page (by default, 100 ). |
OnlyAttached | boolean | If set to true, lists only the policies attached to a user or a group. |
PathPrefix | string | The path prefix you can use to filter the results, set to a slash (/ ) by default. |
Scope | string | The scope to filter policies (ALL | OWS | local ). |
Schema
{
"Marker": "string",
"MaxItems": 0,
"OnlyAttached": true,
"PathPrefix": "string",
"Scope": "string"
}
ListPoliciesResponse
Property | Type | Description |
---|---|---|
IsTruncated | boolean | If true, there are more items to return using the marker in a new request. |
Marker | string | The marker to request the next results page. |
Policies | [Policies] | Information about one or more policies. |
ResponseMetadata | ResponseMetadata | 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"
}
}
ListPolicyVersionsRequest
Property | Type | Description |
---|---|---|
Marker | string | The marker to request the next results page. |
MaxItems | integer | The maximum number of items that can be returned in a single page (by default, 100 ). |
PolicyArn | string | The OUTSCALE Resource Name (ORN) of the policy. |
Schema
{
"Marker": "string",
"MaxItems": 0,
"PolicyArn": "string"
}
ListPolicyVersionsResponse
Property | Type | Description |
---|---|---|
IsTruncated | boolean | If true, there are more items to return using the marker in a new request. |
Marker | string | The marker to request the next results page. |
ResponseMetadata | ResponseMetadata | Information about the response. |
Versions | [Versions] | 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"
}
]
}
ListServerCertificatesRequest
Property | Type | Description |
---|---|---|
Marker | string | The marker to request the next results page. |
MaxItems | integer | The maximum number of items that can be returned in a single page (by default, 1000 ). |
PathPrefix | string | The path prefix of the server certificates, set to a slash (/ ) if not specified. |
Schema
{
"Marker": "string",
"MaxItems": 0,
"PathPrefix": "string"
}
ListServerCertificatesResponse
Property | Type | Description |
---|---|---|
IsTruncated | boolean | If true, there are more items to return using the marker in a new request. |
Marker | string | The marker to request the next results page. |
ResponseMetadata | ResponseMetadata | Information about the response. |
ServerCertificateMetadataList | [ServerCertificateMetadataList] | 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"
}
]
}
ListUserPoliciesRequest
Property | Type | Description |
---|---|---|
UserName | string | The name of the user. |
Schema
{
"UserName": "string"
}
ListUserPoliciesResponse
Property | Type | Description |
---|---|---|
ListUserPoliciesResult | ListUserPoliciesResult | Information about one or more user policies. |
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ListUserPoliciesResult": {
"PolicyNames": "string"
},
"ResponseMetadata": {
"RequestId": "string"
}
}
ListUserPoliciesResult
Information about one or more user policies.
Property | Type | Description |
---|---|---|
PolicyNames | string | A list of policy names. |
Schema
{
"PolicyNames": "string"
}
ListUsersRequest
Property | Type | Description |
---|---|---|
PathPrefix | string | The path prefix. |
Schema
{
"PathPrefix": "string"
}
ListUsersResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Users | [Users] | 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.
Property | Type | Description |
---|---|---|
Arn | string | The unique identifier of the resource (between 20 and 2048 characters). |
AttachmentCount | integer | The number of resources attached to the policy. |
CreateDate | string | The date and time of creation of the policy, in ISO 8601 format. |
DefaultVersionId | string | The ID of the policy default version. |
Description | string | A friendly name for the policy (between 0 and 1000 characters). |
IsAttachable | boolean | Indicates whether the policy can be attached to a group or an EIM user. |
Path | string | The path to the policy. |
PolicyId | string | The ID of the policy (between 16 and 32 characters). |
PolicyName | string | The name of the policy (between 1 and 128 characters). |
UpdateDate | string | 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.
Property | Type | Description |
---|---|---|
Arn | string | The unique identifier of the resource (between 20 and 2048 characters). |
AttachmentCount | integer | The number of resources attached to the policy. |
CreateDate | string | The date and time of creation of the policy, in ISO 8601 format. |
DefaultVersionId | string | The ID of the policy default version. |
Description | string | A friendly name for the policy (between 0 and 1000 characters). |
IsAttachable | boolean | Indicates whether the policy can be attached to a group or an EIM user. |
Path | string | The path to the policy. |
PolicyId | string | The ID of the policy (between 16 and 32 characters). |
PolicyName | string | The name of the policy (between 1 and 128 characters). |
UpdateDate | string | 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.
Property | Type | Description |
---|---|---|
CreateDate | string | The date of the creation of the version. |
Document | string | The policy document as a json string. |
IsDefaultVersion | boolean | If true, the version is the default one. |
VersionId | string | The ID of the version. |
Schema
{
"CreateDate": "string",
"Document": "string",
"IsDefaultVersion": true,
"VersionId": "string"
}
PutGroupPolicyRequest
Property | Type | Description |
---|---|---|
GroupName | string | The name of the group. |
PolicyDocument | string | The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information and EIM Policy Generator. |
PolicyName | string | The name of the policy. |
Schema
{
"GroupName": "string",
"PolicyDocument": "string",
"PolicyName": "string"
}
PutGroupPolicyResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
PutUserPolicyRequest
Property | Type | Description |
---|---|---|
PolicyDocument | string | The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information and EIM Policy Generator. |
PolicyName | string | The name of the policy. |
UserName | string | The name of the user. |
Schema
{
"PolicyDocument": "string",
"PolicyName": "string",
"UserName": "string"
}
PutUserPolicyResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
RemoveUserFromGroupRequest
Property | Type | Description |
---|---|---|
GroupName | string | The name of the group you want to remove the user from. |
UserName | string | The name of the user you want to remove from the group. |
Schema
{
"GroupName": "string",
"UserName": "string"
}
RemoveUserFromGroupResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
ResponseMetadata
Information about the response.
Property | Type | Description |
---|---|---|
RequestId | string | The ID of the request. |
Schema
{
"RequestId": "string"
}
ServerCertificate
Information about the specified server certificate.
Property | Type | Description |
---|---|---|
CertificateBody | string | The PEM-encoded x509 certificate. |
CertificateChain | string | The PEM-encoded intermediate certification authorities. |
ServerCertificateMetadata | ServerCertificateMetadata | 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.
Property | Type | Description |
---|---|---|
Arn | string | The unique identifier of the server certificate (between 20 and 2048 characters), which can be used by EIM policies. |
Expiration | string | The date at which the server certificate expires. |
Path | string | The path to the server certificate. |
ServerCertificateId | string | The ID of the server certificate, generated by EIM. |
ServerCertificateName | string | The name of the server certificate. |
UploadDate | string | 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.
Property | Type | Description |
---|---|---|
Arn | string | The unique identifier of the server certificate (between 20 and 2048 characters), which can be used by EIM policies. |
Expiration | string | The date at which the server certificate expires. |
Path | string | The path to the server certificate. |
ServerCertificateId | string | The ID of the server certificate, generated by EIM. |
ServerCertificateName | string | The name of the server certificate. |
UploadDate | string | The date at which the server certificate has been uploaded. |
Schema
{
"Arn": "string",
"Expiration": "string",
"Path": "string",
"ServerCertificateId": "string",
"ServerCertificateName": "string",
"UploadDate": "string"
}
SetDefaultPolicyVersionRequest
Property | Type | Description |
---|---|---|
PolicyArn | string | The unique identifier (ARN) of the policy. |
VersionId | string | The ID of the version. |
Schema
{
"PolicyArn": "string",
"VersionId": "string"
}
SetDefaultPolicyVersionResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
UpdateAccessKeyRequest
Property | Type | Description |
---|---|---|
AccessKeyId | string | The ID of the access key. |
Status | string | The status of the access key (Active | Inactive ). |
UserName | string | 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. |
Schema
{
"AccessKeyId": "string",
"Status": "string",
"UserName": "string"
}
UpdateAccessKeyResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
UpdateGroupRequest
Property | Type | Description |
---|---|---|
GroupName | string | The name of the group you want to modify. |
NewGroupName | string | A new name for the group. |
NewPath | string | A new path for the group. |
Schema
{
"GroupName": "string",
"NewGroupName": "string",
"NewPath": "string"
}
UpdateGroupResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
UpdateServerCertificateRequest
Property | Type | Description |
---|---|---|
NewPath | string | A new path for the server certificate. |
NewServerCertificateName | string | A new name for the server certificate. |
ServerCertificateName | string | The name of the server certificate you want to modify. |
Schema
{
"NewPath": "string",
"NewServerCertificateName": "string",
"ServerCertificateName": "string"
}
UpdateServerCertificateResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
UpdateUserRequest
Property | Type | Description |
---|---|---|
NewPath | string | A new path for the user. |
NewUserName | string | A new name for the user. |
UserName | string | The name of the user you want to modify. |
Schema
{
"NewPath": "string",
"NewUserName": "string",
"UserName": "string"
}
UpdateUserResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
Schema
{
"ResponseMetadata": {
"RequestId": "string"
}
}
UploadServerCertificateRequest
Property | Type | Description |
---|---|---|
CertificateBody | string | The PEM-encoded X509 certificate. With OSC CLI, use the following syntax to make sure your certificate file is correctly parsed: --CertificateBody="$(cat FILENAME)" . |
CertificateChain | string | The PEM-encoded intermediate certification authorities. With OSC CLI, use the following syntax to make sure your certificate chain file is correctly parsed: --CertificateChain="$(cat FILENAME)" . |
Path | string | The path to the server certificate, set to a slash (/ ) if not specified. |
PrivateKey | string | The PEM-encoded private key matching the certificate. With OSC CLI, use the following syntax to make sure your key file is correctly parsed: --PrivateKey="$(cat FILENAME)" . |
ServerCertificateName | string | A unique name for the certificate. Constraints: 1-128 alphanumeric characters, pluses ( + ), equals (= ), commas (, ), periods (. ), at signs (@ ), minuses (- ), or underscores (_ ). |
Schema
{
"CertificateBody": "string",
"CertificateChain": "string",
"Path": "string",
"PrivateKey": "string",
"ServerCertificateName": "string"
}
UploadServerCertificateResponse
Property | Type | Description |
---|---|---|
ResponseMetadata | ResponseMetadata | Information about the response. |
ServerCertificateMetadata | ServerCertificateMetadata | 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.
Property | Type | Description |
---|---|---|
Arn | string | The unique identifier of the user (between 20 and 2048 characters). |
CreateDate | string | The date and time of creation of the user, in ISO 8601 format. |
PasswordLastUsed | string | The date and time when the user's password was last used, in ISO 8601 format. |
Path | string | The path to the user. |
UserId | string | The ID of the user. |
UserName | string | The name of the user. |
Schema
{
"Arn": "string",
"CreateDate": "string",
"PasswordLastUsed": "string",
"Path": "string",
"UserId": "string",
"UserName": "string"
}
Users
A list of users.
Property | Type | Description |
---|---|---|
Arn | string | The unique identifier of the user (between 20 and 2048 characters). |
CreateDate | string | The date and time of creation of the user, in ISO 8601 format. |
PasswordLastUsed | string | The date and time when the user's password was last used, in ISO 8601 format. |
Path | string | The path to the user. |
UserId | string | The ID of the user. |
UserName | string | 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.
Property | Type | Description |
---|---|---|
CreateDate | string | The date of the creation of the version. |
Document | string | The policy document as a json string. |
IsDefaultVersion | boolean | If true, the version is the default one. |
VersionId | string | The ID of the version. |
Schema
{
"CreateDate": "string",
"Document": "string",
"IsDefaultVersion": true,
"VersionId": "string"
}
AWS™ and Amazon Web Services™ are trademarks of Amazon Technologies, Inc or its affiliates in the United States and/or other countries.