Class Fog::AWS::IAM::Real
In: lib/fog/aws/requests/iam/delete_group.rb
lib/fog/aws/requests/iam/get_user.rb
lib/fog/aws/requests/iam/list_groups_for_user.rb
lib/fog/aws/requests/iam/delete_user.rb
lib/fog/aws/requests/iam/list_server_certificates.rb
lib/fog/aws/requests/iam/update_login_profile.rb
lib/fog/aws/requests/iam/upload_server_certificate.rb
lib/fog/aws/requests/iam/get_user_policy.rb
lib/fog/aws/requests/iam/delete_server_certificate.rb
lib/fog/aws/requests/iam/put_user_policy.rb
lib/fog/aws/requests/iam/upload_signing_certificate.rb
lib/fog/aws/requests/iam/remove_user_from_group.rb
lib/fog/aws/requests/iam/list_user_policies.rb
lib/fog/aws/requests/iam/delete_group_policy.rb
lib/fog/aws/requests/iam/create_access_key.rb
lib/fog/aws/requests/iam/delete_signing_certificate.rb
lib/fog/aws/requests/iam/update_access_key.rb
lib/fog/aws/requests/iam/list_access_keys.rb
lib/fog/aws/requests/iam/update_group.rb
lib/fog/aws/requests/iam/update_signing_certificate.rb
lib/fog/aws/requests/iam/list_groups.rb
lib/fog/aws/requests/iam/create_user.rb
lib/fog/aws/requests/iam/add_user_to_group.rb
lib/fog/aws/requests/iam/create_group.rb
lib/fog/aws/requests/iam/delete_login_profile.rb
lib/fog/aws/requests/iam/list_signing_certificates.rb
lib/fog/aws/requests/iam/create_login_profile.rb
lib/fog/aws/requests/iam/put_group_policy.rb
lib/fog/aws/requests/iam/get_group.rb
lib/fog/aws/requests/iam/get_login_profile.rb
lib/fog/aws/requests/iam/delete_user_policy.rb
lib/fog/aws/requests/iam/update_user.rb
lib/fog/aws/requests/iam/delete_access_key.rb
lib/fog/aws/requests/iam/list_group_policies.rb
lib/fog/aws/requests/iam/list_users.rb
lib/fog/aws/iam.rb
Parent: Object

Methods

Public Class methods

Initialize connection to IAM

Notes

options parameter must include values for :aws_access_key_id and :aws_secret_access_key in order to create a connection

Examples

  iam = IAM.new(
   :aws_access_key_id => your_aws_access_key_id,
   :aws_secret_access_key => your_aws_secret_access_key
  )

Parameters

  • options<~Hash> - config arguments for connection. Defaults to {}.

Returns

  • IAM object with connection to AWS.

Public Instance methods

Add a user to a group

Parameters

  • group_name<~String>: name of the group
  • user_name<~String>: name of user to add

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_AddUserToGroup.html

Create a access keys for user (by default detects user from access credentials)

Parameters

  • options<~Hash>:
    • ‘UserName’<~String> - name of the user to create (do not include path)

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘AccessKey’<~Hash>:
        • ‘AccessKeyId’<~String> -
        • ‘UserName’<~String> -
        • ‘SecretAccessKey’<~String> -
        • ‘Status’<~String> -
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_CreateAccessKey.html

Create a new group

Parameters

  • group_name<~String>: name of the group to create (do not include path)
  • path<~String>: optional path to group, defaults to ’/’

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘Group’<~Hash>:
        • Arn<~String> -
        • GroupId<~String> -
        • GroupName<~String> -
        • Path<~String> -
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_CreateGroup.html

Creates a login profile for a user

docs.amazonwebservices.com/IAM/latest/APIReference/API_CreateLoginProfile.html

Parameters

  • user_name<~String> - Name of user to create a login profile for
  • password<~String> - The new password for this user

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘LoginProfile’<~Hash>
         * UserName<~String>
         * CreateDate
        
      • ‘RequestId’<~String> - Id of the request

Create a new user

Parameters

  • user_name<~String>: name of the user to create (do not include path)
  • path<~String>: optional path to group, defaults to ’/’

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘User’<~Hash>:
        • ‘Arn’<~String> -
        • ‘Path’<~String> -
        • ‘UserId’<~String> -
        • ‘UserName’<~String> -
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_CreateUser.html

Delete an access key

Parameters

  • access_key_id<~String> - Access key id to delete
  • options<~Hash>:
    • ‘UserName’<~String> - name of the user to create (do not include path)

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_DeleteAccessKey.html

Delete a group

Parameters

  • group_name<~String>: name of the group to delete

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_DeleteGroup.html

Remove a policy from a group

Parameters

  • group_name<~String>: name of the group
  • policy_name<~String>: name of policy document

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_DeleteGroupPolicy.html

Deletes a user‘s login profile

docs.amazonwebservices.com/IAM/latest/APIReference/API_DeleteLoginProfile.html

Parameters

  • user_name<~String> - Name of user whose login profile you want to delete

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘RequestId’<~String> - Id of the request

Deletes the specified server certificate.

Parameters

  • server_certificate_name<~String>: The name of the server certificate you want to delete.

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_DeleteServerCertificate.html

Upload signing certificate for user (by default detects user from access credentials)

Parameters

  • options<~Hash>:
    • ‘UserName’<~String> - name of the user to upload certificate for (do not include path)

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_DeleteSigningCertificate.html

Delete a user

Parameters

  • user_name<~String>: name of the user to delete

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_DeleteUser.html

Remove a policy from a user

Parameters

  • user_name<~String>: name of the user
  • policy_name<~String>: name of policy document

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_DeleteUserPolicy.html

Get Group

Parameters

  • ‘GroupName’<~String>: Name of the Group
  • options<~Hash>:
    • ‘Marker’<~String>: Use this only when paginating results, and only in a subsequent request after you‘ve received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
    • ‘MaxItems’<~String>: Use this only when paginating results to indicate the maximum number of User names you want in the response. If there are additional User names beyond the maximum you specify, the IsTruncated response element is true.

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘Group’<~Hash> - Group
        • ‘Path’<~String>
        • ‘GroupName’<~String>
        • ‘Arn’<~String>
      • ‘Users’<~Hash>? - List of users belonging to the group.
        • ‘User’<~Hash> - User
          • Arn<~String> -
          • UserId<~String> -
          • UserName<~String> -
          • Path<~String> -

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_GetGroup.html

Retrieves the login profile for a user

docs.amazonwebservices.com/IAM/latest/APIReference/API_CreateLoginProfile.html

Parameters

  • user_name<~String> - Name of user to retrieve the login profile for
  • password<~String> - The new password for this user

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘LoginProfile’<~Hash>
         * UserName<~String>
         * CreateDate
        
      • ‘RequestId’<~String> - Id of the request

Get User

Parameters

  • options<~Hash>:
    • ‘UserName’<~String>: Name of the User. Defaults to current user

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘User’<~Hash> - User
        • Arn<~String> -
        • UserId<~String> -
        • UserName<~String> -
        • Path<~String> -

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_Getuser.html

Get User Policy

Parameters

  • ‘PolicyName’<~String>: Name of the policy to get
  • ‘UserName’<~String>: Name of the User who the policy is associated with.

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
        * PolicyDocument<~String> The policy document.
        * PolicyName<~String> The name of the policy.
        * UserName<~String> The User the policy is associated with.
      

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_GetUserPolicy.html

List access_keys

Parameters

  • options<~Hash>:
    • ‘Marker’<~String> - used to paginate subsequent requests
    • ‘MaxItems’<~Integer> - limit results to this number per page
    • ‘UserName’<~String> - optional: username to lookup access keys for, defaults to current user

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘AccessKeys’<~Array> - Matching access keys
        • access_key<~Hash>:
          • AccessKeyId<~String> -
          • Status<~String> -
      • ‘IsTruncated<~Boolean> - Whether or not results were truncated
      • ‘Marker’<~String> - appears when IsTruncated is true as the next marker to use
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_ListAccessKeys.html

List policies for a group

Parameters

  • group_name<~String> - Name of group to list policies for
  • options<~Hash>: Optional
    • ‘Marker’<~String>: used to paginate subsequent requests
    • ‘MaxItems’<~Integer>: limit results to this number per page
    • ‘PathPrefix’<~String>: prefix for filtering results

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘PolicyNames’<~Array> - Matching policy names
      • ‘IsTruncated<~Boolean> - Whether or not results were truncated
      • ‘Marker’<~String> - appears when IsTruncated is true as the next marker to use
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_ListGroupPolicies.html

List groups

Parameters

  • options<~Hash>:
    • ‘Marker’<~String>: used to paginate subsequent requests
    • ‘MaxItems’<~Integer>: limit results to this number per page
    • ‘PathPrefix’<~String>: prefix for filtering results

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘Groups’<~Array> - Matching groups
        • group<~Hash>:
          • Arn<~String> -
          • GroupId<~String> -
          • GroupName<~String> -
          • Path<~String> -
      • ‘IsTruncated<~Boolean> - Whether or not results were truncated
      • ‘Marker’<~String> - appears when IsTruncated is true as the next marker to use
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_ListGroups.html

List groups_for_user

Parameters

  • user_name<~String> - the username you want to look up group membership for
  • options<~Hash>:
    • ‘Marker’<~String> - used to paginate subsequent requests
    • ‘MaxItems’<~Integer> - limit results to this number per page

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘GroupsForUser’<~Array> - Groups for a user
        • group_for_user<~Hash>:
          • ‘Arn’ -
          • ‘GroupId’ -
          • ‘GroupName’ -
          • ‘Path’ -
      • ‘IsTruncated’<~Boolean> - Whether or not results were truncated
      • ‘Marker’<~String> - appears when IsTruncated is true as the next marker to use
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_ListGroupsForUser.html

List server certificates

Parameters

  • options<~Hash>:
    • ‘Marker’<~String> - The marker from the previous result (for pagination)
    • ‘MaxItems’<~String> - The maximum number of server certificates you want in the response
    • ‘PathPrefix’<~String> - The path prefix for filtering the results

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘Certificates’<~Array> - Matching server certificates
        • server_certificate<~Hash>:
          • Arn<~String> -
          • Path<~String> -
          • ServerCertificateId<~String> -
          • ServerCertificateName<~String> -
          • UploadDate<~Time> -
        • ‘IsTruncated’<~Boolean> - Whether or not the results were truncated
        • ‘Marker’<~String> - appears when IsTruncated is true as the next marker to use

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_ListServerCertificates.html

List signing certificates for user (by default detects user from access credentials)

Parameters

  • options<~Hash>:
    • ‘UserName’<~String> - name of the user to list certificates for (do not include path)

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘SigningCertificates’<~Array> - Matching signing certificates
        • signing_certificate<~Hash>:
          • CertificateId<~String> -
          • Status<~String> -
        • ‘IsTruncated’<~Boolean> - Whether or not the results were truncated
        • ‘Marker’<~String> - appears when IsTruncated is true as the next marker to use
        • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_ListSigningCertificates.html

List policies for a user

Parameters

  • user_name<~String> - Name of user to list policies for
  • options<~Hash>: Optional
    • ‘Marker’<~String>: used to paginate subsequent requests
    • ‘MaxItems’<~Integer>: limit results to this number per page
    • ‘PathPrefix’<~String>: prefix for filtering results

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘PolicyNames’<~Array> - Matching policy names
      • ‘IsTruncated<~Boolean> - Whether or not results were truncated
      • ‘Marker’<~String> - appears when IsTruncated is true as the next marker to use
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_ListUserPolicies.html

List users

Parameters

  • options<~Hash>:
    • ‘Marker’<~String>: used to paginate subsequent requests
    • ‘MaxItems’<~Integer>: limit results to this number per page
    • ‘PathPrefix’<~String>: prefix for filtering results

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘Users’<~Array> - Matching groups
        • user<~Hash>:
          • Arn<~String> -
          • Path<~String> -
          • UserId<~String> -
          • UserName<~String> -
      • ‘IsTruncated<~Boolean> - Whether or not results were truncated
      • ‘Marker’<~String> - appears when IsTruncated is true as the next marker to use
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_ListUsers.html

Add or update a policy for a group

Parameters

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_PutGroupPolicy.html

Add or update a policy for a user

Parameters

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_PutUserPolicy.html

Remove a user from a group

Parameters

  • group_name<~String>: name of the group
  • user_name<~String>: name of user to remove

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_RemoveUserFromGroup.html

Update an access key for a user

Parameters

  • access_key_id<~String> - Access key id to delete
  • status<~String> - status of keys in [‘Active’, ‘Inactive’]
  • options<~Hash>:
    • ‘UserName’<~String> - name of the user to create (do not include path)

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/API_UpdateAccessKey.html

Update a Group

Parameters

  • group_name<~String> - Required. Name of the Group to update. If you‘re changing the name of the Group, this is the original Group name.
  • options<~Hash>:
    • new_path<~String> - New path for the Group. Include this parameter only if you‘re changing the Group‘s path.
    • new_group_name<~String> - New name for the Group. Include this parameter only if you‘re changing the Group‘s name.

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘RequestId’<~String> - Id of the request
      • ‘Group’<~Hash> - Changed Group info
        • ‘Arn’<~String> -
        • ‘Path’<~String> -
        • ‘GroupId’<~String> -
        • ‘GroupName’<~String> -

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_UpdateGroup.html

Updates a login profile for a user

docs.amazonwebservices.com/IAM/latest/APIReference/API_UpdateLoginProfile.html

Parameters

  • user_name<~String> - Name of user to change the login profile for
  • password<~String> - The new password for this user

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘RequestId’<~String> - Id of the request

Update a Signing Certificate

Parameters

  • certificate_id<~String> - Required. ID of the Certificate to update.
  • status<~String> - Required. Active/Inactive
  • options<~Hash>:
    • user_name<~String> - Name of the user the signing certificate belongs to.

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_UpdateSigningCertificate.html

Update a user

Parameters

  • user_name<~String> - Required. Name of the User to update. If you‘re changing the name of the User, this is the original User name.
  • options<~Hash>:
    • new_path<~String> - New path for the User. Include this parameter only if you‘re changing the User‘s path.
    • new_user_name<~String> - New name for the User. Include this parameter only if you‘re changing the User‘s name.

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘RequestId’<~String> - Id of the request
      • ‘User’<~Hash> - Changed user info
        • ‘Arn’<~String> -
        • ‘Path’<~String> -
        • ‘UserId’<~String> -
        • ‘UserName’<~String> -

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_UpdateUser.html

Uploads a server certificate entity for the AWS Account. Includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.

Parameters

  • certificate<~Hash>: The contents of the public key certificate in PEM-encoded format.
  • private_key<~Hash>: The contents of the private key in PEM-encoded format.
  • name<~Hash>: The name for the server certificate. Do not include the path in this value.
  • options<~Hash>:
    • ‘CertificateChain’<~String> - The contents of the certificate chain. Typically a concatenation of the PEM-encoded public key certificates of the chain.
    • ‘Path’<~String> - The path for the server certificate.

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘UploadServerCertificateResult’<~Hash>:
        • ‘CertificateId’<~String> -
        • ‘UserName’<~String> -
        • ‘CertificateBody’<~String> -
        • ‘Status’<~String> -
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_UploadServerCertificate.html

Upload signing certificate for user (by default detects user from access credentials)

Parameters

  • options<~Hash>:
    • ‘UserName’<~String> - name of the user to upload certificate for (do not include path)

Returns

  • response<~Excon::Response>:
    • body<~Hash>:
      • ‘Certificate’<~Hash>:
        • ‘CertificateId’<~String> -
        • ‘UserName’<~String> -
        • ‘CertificateBody’<~String> -
        • ‘Status’<~String> -
      • ‘RequestId’<~String> - Id of the request

See Also

docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_UploadSigningCertificate.html

[Validate]